aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenawi Adha <benawiadha@gmail.com>2022-10-02 21:22:38 +0700
committerBenawi Adha <benawiadha@gmail.com>2022-10-02 21:22:38 +0700
commit258c30d2e088cd4ab091a53794da3f93af79915d (patch)
treef49340bf565deb20c730358af74a01bcc231de53
parentd43533f01d9d5baf5f78b71f832641382bd5962a (diff)
downloadepy-258c30d2e088cd4ab091a53794da3f93af79915d.tar.gz
Major refactor: breakdown epy.py script
into package project structure for easier development Squashed commit of the following: commit 01309b961a4ab32394bff0d90949b57435dfda47 Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 21:15:04 2022 +0700 Fix missing objects commit aab2e773c30b255c81b1250b3b20967d5da40338 Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 21:09:31 2022 +0700 Update README.md commit d4e98926bcd9b00ce0410ad71249d24e6315abc5 Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 21:07:28 2022 +0700 Add keywords in pyproject.toml commit 432055af8245560a3ff2e046aef0b4e87da44930 Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 21:04:34 2022 +0700 Bump version and deprecete setup.py commit 51dd15aab8f8ff5996f822f8378e813f0b9fb80d Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 20:56:38 2022 +0700 Formatting commit 81fb35e3b6fa0e27d79ef1da77202ed81eb99500 Author: Benawi Adha <benawiadha@gmail.com> Date: Sun Oct 2 20:55:08 2022 +0700 Fix speakers module commit 3b852e7c59b38d5a28520038e35f50a95270d2f1 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:52:46 2022 +0700 Fix circular import commit 061e8a2649dabacd28a9e2f972559475316c654c Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:39:27 2022 +0700 Run formatting commit abc2d0ab156992c63dc04745d14a69679a60accb Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:39:00 2022 +0700 Update isort and black config in pyproject commit 5dc2e41bab5b997bd719bdc1561eb51ba0c17a83 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:31:00 2022 +0700 Add app Config commit ed485a2ea8281585bf86dc5772f0c6dd9c803cc4 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:23:02 2022 +0700 Update debugpy script commit 68b0553dd4d63eb4b847132c68ea4018587fa8ec Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:14:11 2022 +0700 Connect reader to main script commit 63c3dd176f18a784a4ed2e88aa72b13d1c2b0990 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 20:11:17 2022 +0700 Implement reader commit ce5eec8fb4e1db3870a16a07541365cd777d6c4c Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 19:29:49 2022 +0700 Fix script in pyproject.toml commit 941e8e49f1593731fb582d92084206772b3f0442 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 19:28:39 2022 +0700 Rename modules commit 5a3e7f766aee774c09b3b5336f3a2968e9cb1d0c Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 19:28:20 2022 +0700 Rename tool method commit 3c0503ff475cb7eff8b12d3be0bda7a38efe1072 Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 19:27:03 2022 +0700 Add ebooks lib commit b5f71c3296a7d6f36454f6e1cbe84e15a45092ee Author: Benawi Adha <benawiadha@gmail.com> Date: Sat Oct 1 17:25:11 2022 +0700 Initial reorganization
Diffstat
-rw-r--r--Makefile13
-rw-r--r--README.md2
-rw-r--r--epy_extras/__init__.py3
-rw-r--r--poetry.lock502
-rw-r--r--pyproject.toml43
-rw-r--r--setup.py28
-rw-r--r--src/epy_reader/__init__.py5
-rw-r--r--src/epy_reader/__main__.py23
-rw-r--r--src/epy_reader/board.py148
-rw-r--r--src/epy_reader/cli.py171
-rw-r--r--src/epy_reader/config.py80
-rw-r--r--src/epy_reader/ebooks/__init__.py15
-rw-r--r--src/epy_reader/ebooks/azw.py26
-rw-r--r--src/epy_reader/ebooks/base.py48
-rw-r--r--src/epy_reader/ebooks/epub.py202
-rw-r--r--src/epy_reader/ebooks/fictionbook.py76
-rw-r--r--src/epy_reader/ebooks/mobi.py69
-rw-r--r--src/epy_reader/ebooks/url.py49
-rw-r--r--src/epy_reader/lib.py63
-rw-r--r--src/epy_reader/models.py232
-rw-r--r--src/epy_reader/parser.py421
-rw-r--r--src/epy_reader/reader.py1610
-rw-r--r--src/epy_reader/settings.py133
-rw-r--r--src/epy_reader/speakers/__init__.py9
-rw-r--r--src/epy_reader/speakers/base.py21
-rw-r--r--src/epy_reader/speakers/mimic.py31
-rw-r--r--src/epy_reader/speakers/pico.py43
-rw-r--r--src/epy_reader/state.py195
-rw-r--r--src/epy_reader/tools/KindleUnpack/__init__.py (renamed from epy_extras/KindleUnpack/__init__.py)0
-rwxr-xr-xsrc/epy_reader/tools/KindleUnpack/compatibility_utils.py (renamed from epy_extras/KindleUnpack/compatibility_utils.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/kindleunpack.py (renamed from epy_extras/KindleUnpack/kindleunpack.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_cover.py (renamed from epy_extras/KindleUnpack/mobi_cover.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_dict.py (renamed from epy_extras/KindleUnpack/mobi_dict.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_header.py (renamed from epy_extras/KindleUnpack/mobi_header.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_html.py (renamed from epy_extras/KindleUnpack/mobi_html.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_index.py (renamed from epy_extras/KindleUnpack/mobi_index.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_k8proc.py (renamed from epy_extras/KindleUnpack/mobi_k8proc.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_k8resc.py (renamed from epy_extras/KindleUnpack/mobi_k8resc.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_nav.py (renamed from epy_extras/KindleUnpack/mobi_nav.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_ncx.py (renamed from epy_extras/KindleUnpack/mobi_ncx.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_opf.py (renamed from epy_extras/KindleUnpack/mobi_opf.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_pagemap.py (renamed from epy_extras/KindleUnpack/mobi_pagemap.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_sectioner.py (renamed from epy_extras/KindleUnpack/mobi_sectioner.py)0
-rwxr-xr-xsrc/epy_reader/tools/KindleUnpack/mobi_split.py (renamed from epy_extras/KindleUnpack/mobi_split.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_uncompress.py (renamed from epy_extras/KindleUnpack/mobi_uncompress.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/mobi_utils.py (renamed from epy_extras/KindleUnpack/mobi_utils.py)0
-rwxr-xr-xsrc/epy_reader/tools/KindleUnpack/mobiml2xhtml.py (renamed from epy_extras/KindleUnpack/mobiml2xhtml.py)0
-rwxr-xr-xsrc/epy_reader/tools/KindleUnpack/unipath.py (renamed from epy_extras/KindleUnpack/unipath.py)0
-rw-r--r--src/epy_reader/tools/KindleUnpack/unpack_structure.py (renamed from epy_extras/KindleUnpack/unpack_structure.py)0
-rw-r--r--src/epy_reader/tools/__init__.py3
-rw-r--r--src/epy_reader/utils.py377
51 files changed, 4562 insertions, 79 deletions
diff --git a/Makefile b/Makefile
index 3c5fcca..3d03560 100644
--- a/Makefile
+++ b/Makefile
@@ -1,8 +1,15 @@
.PHONY: tests
-.DEFAULT_GOAL := tests
+.DEFAULT_GOAL := check
+
+check:
+ mypy --follow-imports=silent src
+
+format:
+ isort src
+ black src
debug:
- python -m debugpy --listen 5678 --wait-for-client -m epy
+ python -m debugpy --listen 5678 --wait-for-client -m epy_reader
dev:
poetry install
@@ -16,5 +23,5 @@ coverage:
python -m http.server -d htmlcov
release:
- python setup.py sdist bdist_wheel
+ python -m build
twine upload --skip-existing dist/*
diff --git a/README.md b/README.md
index 0dcfdd7..98a671a 100644
--- a/README.md
+++ b/README.md
@@ -134,3 +134,5 @@ so line scrolling navigation will act as scrolling page and textwidth is not adj
inside epy (default key: `R`).
- `v2022.2.5`: Fix process.join() issue for unstarted process.
+
+- `v2022.10.2`: Major breakdown `epy.py` module into package structure for easier development.
diff --git a/epy_extras/__init__.py b/epy_extras/__init__.py
deleted file mode 100644
index c06e358..0000000
--- a/epy_extras/__init__.py
+++ /dev/null
@@ -1,3 +0,0 @@
-__all__ = ["unpackBook"]
-
-from .KindleUnpack.kindleunpack import unpackBook
diff --git a/poetry.lock b/poetry.lock
index 224fda9..0547abc 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -7,6 +7,20 @@ optional = false
python-versions = "*"
[[package]]
+name = "asttokens"
+version = "2.0.8"
+description = "Annotate AST trees with source code positions"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.dependencies]
+six = "*"
+
+[package.extras]
+test = ["astroid (<=2.5.3)", "pytest"]
+
+[[package]]
name = "attrs"
version = "22.1.0"
description = "Classes Without Boilerplate"
@@ -42,7 +56,6 @@ mypy-extensions = ">=0.4.3"
pathspec = ">=0.9.0"
platformdirs = ">=2"
tomli = {version = ">=1.1.0", markers = "python_full_version < \"3.11.0a7\""}
-typed-ast = {version = ">=1.4.2", markers = "python_version < \"3.8\" and implementation_name == \"cpython\""}
typing-extensions = {version = ">=3.10.0.0", markers = "python_version < \"3.10\""}
[package.extras]
@@ -52,6 +65,72 @@ jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
uvloop = ["uvloop (>=0.15.2)"]
[[package]]
+name = "bleach"
+version = "5.0.1"
+description = "An easy safelist-based HTML-sanitizing tool."
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.dependencies]
+six = ">=1.9.0"
+webencodings = "*"
+
+[package.extras]
+css = ["tinycss2 (>=1.1.0,<1.2)"]
+dev = ["build (==0.8.0)", "flake8 (==4.0.1)", "hashin (==0.17.0)", "pip-tools (==6.6.2)", "pytest (==7.1.2)", "Sphinx (==4.3.2)", "tox (==3.25.0)", "twine (==4.0.1)", "wheel (==0.37.1)", "black (==22.3.0)", "mypy (==0.961)"]
+
+[[package]]
+name = "build"
+version = "0.8.0"
+description = "A simple, correct PEP 517 build frontend"
+category = "dev"
+optional = false
+python-versions = ">=3.6"
+
+[package.dependencies]
+colorama = {version = "*", markers = "os_name == \"nt\""}
+packaging = ">=19.0"
+pep517 = ">=0.9.1"
+tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
+
+[package.extras]
+virtualenv = ["virtualenv (>=20.0.35)"]
+typing = ["typing-extensions (>=3.7.4.3)", "mypy (==0.950)", "importlib-metadata (>=4.6.4)"]
+test = ["setuptools (>=56.0.0)", "setuptools (>=42.0.0)", "wheel (>=0.36.0)", "toml (>=0.10.0)", "pytest-xdist (>=1.34)", "pytest-rerunfailures (>=9.1)", "pytest-mock (>=2)", "pytest-cov (>=2.12)", "pytest (>=6.2.4)", "filelock (>=3)"]
+docs = ["sphinx-autodoc-typehints (>=1.10)", "sphinx-argparse-cli (>=1.5)", "sphinx (>=4.0,<5.0)", "furo (>=2021.08.31)"]
+
+[[package]]
+name = "certifi"
+version = "2022.9.24"
+description = "Python package for providing Mozilla's CA Bundle."
+category = "dev"
+optional = false
+python-versions = ">=3.6"
+
+[[package]]
+name = "cffi"
+version = "1.15.1"
+description = "Foreign Function Interface for Python calling C code."
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.dependencies]
+pycparser = "*"
+
+[[package]]
+name = "charset-normalizer"
+version = "2.1.1"
+description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet."
+category = "dev"
+optional = false
+python-versions = ">=3.6.0"
+
+[package.extras]
+unicode_backport = ["unicodedata2"]
+
+[[package]]
name = "click"
version = "8.1.3"
description = "Composable command line interface toolkit"
@@ -61,7 +140,6 @@ python-versions = ">=3.7"
[package.dependencies]
colorama = {version = "*", markers = "platform_system == \"Windows\""}
-importlib-metadata = {version = "*", markers = "python_version < \"3.8\""}
[[package]]
name = "colorama"
@@ -72,8 +150,19 @@ optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
[[package]]
+name = "commonmark"
+version = "0.9.1"
+description = "Python parser for the CommonMark Markdown spec"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.extras]
+test = ["flake8 (==3.7.8)", "hypothesis (==3.55.3)"]
+
+[[package]]
name = "coverage"
-version = "6.4.4"
+version = "6.5.0"
description = "Code coverage measurement for Python"
category = "dev"
optional = false
@@ -83,6 +172,25 @@ python-versions = ">=3.7"
toml = ["tomli"]
[[package]]
+name = "cryptography"
+version = "38.0.1"
+description = "cryptography is a package which provides cryptographic recipes and primitives to Python developers."
+category = "dev"
+optional = false
+python-versions = ">=3.6"
+
+[package.dependencies]
+cffi = ">=1.12"
+
+[package.extras]
+docs = ["sphinx (>=1.6.5,!=1.8.0,!=3.1.0,!=3.1.1)", "sphinx-rtd-theme"]
+docstest = ["pyenchant (>=1.6.11)", "twine (>=1.12.0)", "sphinxcontrib-spelling (>=4.0.1)"]
+pep8test = ["black", "flake8", "flake8-import-order", "pep8-naming"]
+sdist = ["setuptools-rust (>=0.11.4)"]
+ssh = ["bcrypt (>=3.1.5)"]
+test = ["pytest (>=6.2.0)", "pytest-benchmark", "pytest-cov", "pytest-subtests", "pytest-xdist", "pretend", "iso8601", "pytz", "hypothesis (>=1.11.4,!=3.79.2)"]
+
+[[package]]
name = "debugpy"
version = "1.6.3"
description = "An implementation of the Debug Adapter Protocol for Python"
@@ -99,6 +207,25 @@ optional = false
python-versions = ">=3.5"
[[package]]
+name = "docutils"
+version = "0.19"
+description = "Docutils -- Python Documentation Utilities"
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[[package]]
+name = "executing"
+version = "1.1.0"
+description = "Get the currently executing AST node of a frame, and other information"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.extras]
+tests = ["rich", "littleutils", "pytest", "asttokens"]
+
+[[package]]
name = "greenlet"
version = "1.1.3"
description = "Lightweight in-process concurrent programming"
@@ -110,21 +237,28 @@ python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*"
docs = ["sphinx"]
[[package]]
+name = "idna"
+version = "3.4"
+description = "Internationalized Domain Names in Applications (IDNA)"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[[package]]
name = "importlib-metadata"
-version = "4.12.0"
+version = "5.0.0"
description = "Read metadata from Python packages"
category = "dev"
optional = false
python-versions = ">=3.7"
[package.dependencies]
-typing-extensions = {version = ">=3.6.4", markers = "python_version < \"3.8\""}
zipp = ">=0.5"
[package.extras]
-docs = ["sphinx", "jaraco.packaging (>=9)", "rst.linker (>=1.9)"]
+docs = ["sphinx (>=3.5)", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "furo", "jaraco.tidelift (>=1.4)"]
perf = ["ipython"]
-testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-cov", "pytest-enabler (>=1.3)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "importlib-resources (>=1.3)"]
+testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "packaging", "pyfakefs", "flufl.flake8", "pytest-perf (>=0.9.2)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)", "importlib-resources (>=1.3)"]
[[package]]
name = "iniconfig"
@@ -136,11 +270,11 @@ python-versions = "*"
[[package]]
name = "ipython"
-version = "7.34.0"
+version = "8.5.0"
description = "IPython: Productive Interactive Computing"
category = "dev"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
[package.dependencies]
appnope = {version = "*", markers = "sys_platform == \"darwin\""}
@@ -151,20 +285,52 @@ jedi = ">=0.16"
matplotlib-inline = "*"
pexpect = {version = ">4.3", markers = "sys_platform != \"win32\""}
pickleshare = "*"
-prompt-toolkit = ">=2.0.0,<3.0.0 || >3.0.0,<3.0.1 || >3.0.1,<3.1.0"
-pygments = "*"
-traitlets = ">=4.2"
+prompt-toolkit = ">3.0.1,<3.1.0"
+pygments = ">=2.4.0"
+stack-data = "*"
+traitlets = ">=5"
[package.extras]
-all = ["Sphinx (>=1.3)", "ipykernel", "ipyparallel", "ipywidgets", "nbconvert", "nbformat", "nose (>=0.10.1)", "notebook", "numpy (>=1.17)", "pygments", "qtconsole", "requests", "testpath"]
+all = ["black", "Sphinx (>=1.3)", "ipykernel", "nbconvert", "nbformat", "ipywidgets", "notebook", "ipyparallel", "qtconsole", "pytest (<7.1)", "pytest-asyncio", "testpath", "curio", "matplotlib (!=3.2.0)", "numpy (>=1.19)", "pandas", "trio"]
+black = ["black"]
doc = ["Sphinx (>=1.3)"]
kernel = ["ipykernel"]
nbconvert = ["nbconvert"]
nbformat = ["nbformat"]
-notebook = ["notebook", "ipywidgets"]
+notebook = ["ipywidgets", "notebook"]
parallel = ["ipyparallel"]
qtconsole = ["qtconsole"]
-test = ["nose (>=0.10.1)", "requests", "testpath", "pygments", "nbformat", "ipykernel", "numpy (>=1.17)"]
+test = ["pytest (<7.1)", "pytest-asyncio", "testpath"]
+test_extra = ["pytest (<7.1)", "pytest-asyncio", "testpath", "curio", "matplotlib (!=3.2.0)", "nbformat", "numpy (>=1.19)", "pandas", "trio"]
+
+[[package]]
+name = "isort"
+version = "5.10.1"
+description = "A Python utility / library to sort Python imports."
+category = "dev"
+optional = false
+python-versions = ">=3.6.1,<4.0"
+
+[package.extras]
+pipfile_deprecated_finder = ["pipreqs", "requirementslib"]
+requirements_deprecated_finder = ["pipreqs", "pip-api"]
+colors = ["colorama (>=0.4.3,<0.5.0)"]
+plugins = ["setuptools"]
+
+[[package]]
+name = "jaraco.classes"
+version = "3.2.3"
+description = "Utility functions for Python class constructs"
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.dependencies]
+more-itertools = "*"
+
+[package.extras]
+docs = ["sphinx (>=3.5)", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "jaraco.tidelift (>=1.4)"]
+testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)"]
[[package]]
name = "jedi"
@@ -182,6 +348,37 @@ qa = ["flake8 (==3.8.3)", "mypy (==0.782)"]
testing = ["Django (<3.1)", "colorama", "docopt", "pytest (<7.0.0)"]
[[package]]
+name = "jeepney"
+version = "0.8.0"
+description = "Low-level, pure Python DBus protocol wrapper."
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.extras]
+trio = ["async-generator", "trio"]
+test = ["async-timeout", "trio", "testpath", "pytest-asyncio (>=0.17)", "pytest-trio", "pytest"]
+
+[[package]]
+name = "keyring"
+version = "23.9.3"
+description = "Store and access your passwords safely."
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.dependencies]
+importlib-metadata = {version = ">=3.6", markers = "python_version < \"3.10\""}
+"jaraco.classes" = "*"
+jeepney = {version = ">=0.4.2", markers = "sys_platform == \"linux\""}
+pywin32-ctypes = {version = "<0.1.0 || >0.1.0,<0.1.1 || >0.1.1", markers = "sys_platform == \"win32\""}
+SecretStorage = {version = ">=3.2", markers = "sys_platform == \"linux\""}
+
+[package.extras]
+docs = ["sphinx", "jaraco.packaging (>=9)", "rst.linker (>=1.9)", "jaraco.tidelift (>=1.4)"]
+testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "flake8 (<5)", "pytest-cov", "pytest-enabler (>=1.3)", "pytest-black (>=0.3.7)", "pytest-mypy (>=0.9.1)"]
+
+[[package]]
name = "matplotlib-inline"
version = "0.1.6"
description = "Inline Matplotlib backend for Jupyter"
@@ -193,6 +390,14 @@ python-versions = ">=3.5"
traitlets = "*"
[[package]]
+name = "more-itertools"
+version = "8.14.0"
+description = "More routines for operating on iterables, beyond itertools"
+category = "dev"
+optional = false
+python-versions = ">=3.5"
+
+[[package]]
name = "msgpack"
version = "1.0.4"
description = "MessagePack serializer"
@@ -202,16 +407,15 @@ python-versions = "*"
[[package]]
name = "mypy"
-version = "0.971"
+version = "0.981"
description = "Optional static typing for Python"
category = "dev"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.7"
[package.dependencies]
mypy-extensions = ">=0.4.3"
tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
-typed-ast = {version = ">=1.4.0,<2", markers = "python_version < \"3.8\""}
typing-extensions = ">=3.10"
[package.extras]
@@ -259,6 +463,17 @@ optional = false
python-versions = ">=3.7"
[[package]]
+name = "pep517"
+version = "0.13.0"
+description = "Wrappers to build Python packages using PEP 517 hooks"
+category = "dev"
+optional = false
+python-versions = ">=3.6"
+
+[package.dependencies]
+tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
+
+[[package]]
name = "pexpect"
version = "4.8.0"
description = "Pexpect allows easy control of interactive console applications."
@@ -278,6 +493,17 @@ optional = false
python-versions = "*"
[[package]]
+name = "pkginfo"
+version = "1.8.3"
+description = "Query metadatdata from sdists / bdists / installed packages."
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*"
+
+[package.extras]
+testing = ["nose", "coverage"]
+
+[[package]]
name = "platformdirs"
version = "2.5.2"
description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
@@ -297,9 +523,6 @@ category = "dev"
optional = false
python-versions = ">=3.6"
-[package.dependencies]
-importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""}
-
[package.extras]
dev = ["pre-commit", "tox"]
testing = ["pytest", "pytest-benchmark"]
@@ -324,6 +547,17 @@ optional = false
python-versions = "*"
[[package]]
+name = "pure-eval"
+version = "0.2.2"
+description = "Safely evaluate AST nodes without side effects"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.extras]
+tests = ["pytest"]
+
+[[package]]
name = "py"
version = "1.11.0"
description = "library with cross-python path, ini-parsing, io, code, log facilities"
@@ -332,6 +566,14 @@ optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
[[package]]
+name = "pycparser"
+version = "2.21"
+description = "C parser in Python"
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+
+[[package]]
name = "pygments"
version = "2.13.0"
description = "Pygments is a syntax highlighting package written in Python."
@@ -380,7 +622,6 @@ python-versions = ">=3.7"
[package.dependencies]
attrs = ">=19.2.0"
colorama = {version = "*", markers = "sys_platform == \"win32\""}
-importlib-metadata = {version = ">=0.12", markers = "python_version < \"3.8\""}
iniconfig = "*"
packaging = "*"
pluggy = ">=0.12,<2.0"
@@ -391,6 +632,122 @@ tomli = ">=1.0.0"
testing = ["argcomplete", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "xmlschema"]
[[package]]
+name = "pywin32-ctypes"
+version = "0.2.0"
+description = ""
+category = "dev"
+optional = false
+python-versions = "*"
+
+[[package]]
+name = "readme-renderer"
+version = "37.2"
+description = "readme_renderer is a library for rendering \"readme\" descriptions for Warehouse"
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.dependencies]
+bleach = ">=2.1.0"
+docutils = ">=0.13.1"
+Pygments = ">=2.5.1"
+
+[package.extras]
+md = ["cmarkgfm (>=0.8.0)"]
+
+[[package]]
+name = "requests"
+version = "2.28.1"
+description = "Python HTTP for Humans."
+category = "dev"
+optional = false
+python-versions = ">=3.7, <4"
+
+[package.dependencies]
+certifi = ">=2017.4.17"
+charset-normalizer = ">=2,<3"
+idna = ">=2.5,<4"
+urllib3 = ">=1.21.1,<1.27"
+
+[package.extras]
+socks = ["PySocks (>=1.5.6,!=1.5.7)"]
+use_chardet_on_py3 = ["chardet (>=3.0.2,<6)"]
+
+[[package]]
+name = "requests-toolbelt"
+version = "0.9.1"
+description = "A utility belt for advanced users of python-requests"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.dependencies]
+requests = ">=2.0.1,<3.0.0"
+
+[[package]]
+name = "rfc3986"
+version = "2.0.0"
+description = "Validating URI References per RFC 3986"
+category = "dev"
+optional = false
+python-versions = ">=3.7"
+
+[package.extras]
+idna2008 = ["idna"]
+
+[[package]]
+name = "rich"
+version = "12.5.1"
+description = "Render rich text, tables, progress bars, syntax highlighting, markdown and more to the terminal"
+category = "dev"
+optional = false
+python-versions = ">=3.6.3,<4.0.0"
+
+[package.dependencies]
+commonmark = ">=0.9.0,<0.10.0"
+pygments = ">=2.6.0,<3.0.0"
+typing-extensions = {version = ">=4.0.0,<5.0", markers = "python_version < \"3.9\""}
+
+[package.extras]
+jupyter = ["ipywidgets (>=7.5.1,<8.0.0)"]
+
+[[package]]
+name = "secretstorage"
+version = "3.3.3"
+description = "Python bindings to FreeDesktop.org Secret Service API"
+category = "dev"
+optional = false
+python-versions = ">=3.6"
+
+[package.dependencies]
+cryptography = ">=2.0"
+jeepney = ">=0.6"
+
+[[package]]
+name = "six"
+version = "1.16.0"
+description = "Python 2 and 3 compatibility utilities"
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
+
+[[package]]
+name = "stack-data"
+version = "0.5.1"
+description = "Extract data from python stack frames and tracebacks for informative displays"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[package.dependencies]
+asttokens = "*"
+executing = "*"
+pure-eval = "*"
+
+[package.extras]
+tests = ["cython", "littleutils", "pygments", "typeguard", "pytest"]
+
+[[package]]
name = "tomli"
version = "2.0.1"
description = "A lil' TOML parser"
@@ -410,12 +767,23 @@ python-versions = ">=3.7"
test = ["pre-commit", "pytest"]
[[package]]
-name = "typed-ast"
-version = "1.5.4"
-description = "a fork of Python 2 and 3 ast modules with type comment support"
+name = "twine"
+version = "4.0.1"
+description = "Collection of utilities for publishing packages on PyPI"
category = "dev"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.7"
+
+[package.dependencies]
+importlib-metadata = ">=3.6"
+keyring = ">=15.1"
+pkginfo = ">=1.8.1"
+readme-renderer = ">=35.0"
+requests = ">=2.20"
+requests-toolbelt = ">=0.8.0,<0.9.0 || >0.9.0"
+rfc3986 = ">=1.4.0"
+rich = ">=12.0.0"
+urllib3 = ">=1.26.0"
[[package]]
name = "typing-extensions"
@@ -426,6 +794,19 @@ optional = false
python-versions = ">=3.7"
[[package]]
+name = "urllib3"
+version = "1.26.12"
+description = "HTTP library with thread-safe connection pooling, file post, and more."
+category = "dev"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, <4"
+
+[package.extras]
+brotli = ["brotlicffi (>=0.8.0)", "brotli (>=1.0.9)", "brotlipy (>=0.6.0)"]
+secure = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "certifi", "urllib3-secure-extra", "ipaddress"]
+socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"]
+
+[[package]]
name = "wcwidth"
version = "0.2.5"
description = "Measures the displayed width of unicode strings in a terminal"
@@ -434,6 +815,14 @@ optional = false
python-versions = "*"
[[package]]
+name = "webencodings"
+version = "0.5.1"
+description = "Character encoding aliases for legacy web content"
+category = "dev"
+optional = false
+python-versions = "*"
+
+[[package]]
name = "windows-curses"
version = "2.3.0"
description = "Support for the standard curses module on Windows"
@@ -455,40 +844,62 @@ testing = ["pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-flake8", "pytest-
[metadata]
lock-version = "1.1"
-python-versions = "^3.7"
-content-hash = "688a03f5baf4d8cc6850f78d49f42245b7d3ae2eaf21ea326732af64617805ff"
+python-versions = "^3.8"
+content-hash = "936a54c993790e03f357a092c82f5d0fc8fdeba780d7c66be761b86ff4d00760"
[metadata.files]
appnope = [
{file = "appnope-0.1.3-py2.py3-none-any.whl", hash = "sha256:265a455292d0bd8a72453494fa24df5a11eb18373a60c7c0430889f22548605e"},
{file = "appnope-0.1.3.tar.gz", hash = "sha256:02bd91c4de869fbb1e1c50aafc4098827a7a54ab2f39d9dcba6c9547ed920e24"},
]
+asttokens = []
attrs = []
backcall = [
{file = "backcall-0.2.0-py2.py3-none-any.whl", hash = "sha256:fbbce6a29f263178a1f7915c1940bde0ec2b2a967566fe1c65c1dfb7422bd255"},
{file = "backcall-0.2.0.tar.gz", hash = "sha256:5cbdbf27be5e7cfadb448baf0aa95508f91f2bbc6c6437cd9cd06e2a4c215e1e"},
]
black = []
+bleach = []
+build = []
+certifi = []
+cffi = []
+charset-normalizer = []
click = []
colorama = []
+commonmark = [
+ {file = "commonmark-0.9.1-py2.py3-none-any.whl", hash = "sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9"},
+ {file = "commonmark-0.9.1.tar.gz", hash = "sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60"},
+]
coverage = []
+cryptography = []
debugpy = []
decorator = [
{file = "decorator-5.1.1-py3-none-any.whl", hash = "sha256:b8c3f85900b9dc423225913c5aace94729fe1fa9763b38939a95226f02d37186"},
{file = "decorator-5.1.1.tar.gz", hash = "sha256:637996211036b6385ef91435e4fae22989472f9d571faba8927ba8253acbc330"},
]
+docutils = []
+executing = []
greenlet = []
+idna = []
importlib-metadata = []
iniconfig = [
{file = "iniconfig-1.1.1-py2.py3-none-any.whl", hash = "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3"},
{file = "iniconfig-1.1.1.tar.gz", hash = "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32"},
]
ipython = []
+isort = [
+ {file = "isort-5.10.1-py3-none-any.whl", hash = "sha256:6f62d78e2f89b4500b080fe3a81690850cd254227f27f75c3a0c491a1f351ba7"},
+ {file = "isort-5.10.1.tar.gz", hash = "sha256:e8443a5e7a020e9d7f97f1d7d9cd17c88bcb3bc7e218bf9cf5095fe550be2951"},
+]
+"jaraco.classes" = []
jedi = [
{file = "jedi-0.18.1-py2.py3-none-any.whl", hash = "sha256:637c9635fcf47945ceb91cd7f320234a7be540ded6f3e99a50cb6febdfd1ba8d"},
{file = "jedi-0.18.1.tar.gz", hash = "sha256:74137626a64a99c8eb6ae5832d99b3bdd7d29a3850fe2aa80a4126b2a7d949ab"},
]
+jeepney = []
+keyring = []
matplotlib-inline = []
+more-itertools = []
msgpack = []
mypy = []
mypy-extensions = [
@@ -504,6 +915,7 @@ parso = [
{file = "parso-0.8.3.tar.gz", hash = "sha256:8c07be290bb59f03588915921e29e8a50002acaf2cdc5fa0e0114f91709fafa0"},
]
pathspec = []
+pep517 = []
pexpect = [
{file = "pexpect-4.8.0-py2.py3-none-any.whl", hash = "sha256:0b48a55dcb3c05f3329815901ea4fc1537514d6ba867a152b581d69ae3710937"},
{file = "pexpect-4.8.0.tar.gz", hash = "sha256:fc65a43959d153d0114afe13997d439c22823a27cefceb5ff35c2178c6784c0c"},
@@ -512,6 +924,7 @@ pickleshare = [
{file = "pickleshare-0.7.5-py2.py3-none-any.whl", hash = "sha256:9649af414d74d4df115d5d718f82acb59c9d418196b7b4290ed47a12ce62df56"},
{file = "pickleshare-0.7.5.tar.gz", hash = "sha256:87683d47965c1da65cdacaf31c8441d12b8044cdec9aca500cd78fc2c683afca"},
]
+pkginfo = []
platformdirs = [
{file = "platformdirs-2.5.2-py3-none-any.whl", hash = "sha256:027d8e83a2d7de06bbac4e5ef7e023c02b863d7ea5d079477e722bb41ab25788"},
{file = "platformdirs-2.5.2.tar.gz", hash = "sha256:58c8abb07dcb441e6ee4b11d8df0ac856038f944ab98b7be6b27b2a3c7feef19"},
@@ -525,27 +938,58 @@ ptyprocess = [
{file = "ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35"},
{file = "ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220"},
]
+pure-eval = [
+ {file = "pure_eval-0.2.2-py3-none-any.whl", hash = "sha256:01eaab343580944bc56080ebe0a674b39ec44a945e6d09ba7db3cb8cec289350"},
+ {file = "pure_eval-0.2.2.tar.gz", hash = "sha256:2b45320af6dfaa1750f543d714b6d1c520a1688dec6fd24d339063ce0aaa9ac3"},
+]
py = [
{file = "py-1.11.0-py2.py3-none-any.whl", hash = "sha256:607c53218732647dff4acdfcd50cb62615cedf612e72d1724fb1a0cc6405b378"},
{file = "py-1.11.0.tar.gz", hash = "sha256:51c75c4126074b472f746a24399ad32f6053d1b34b68d2fa41e558e6f4a98719"},
]
+pycparser = [
+ {file = "pycparser-2.21-py2.py3-none-any.whl", hash = "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9"},
+ {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"},
+]
pygments = []
pynvim = [
{file = "pynvim-0.4.3.tar.gz", hash = "sha256:3a795378bde5e8092fbeb3a1a99be9c613d2685542f1db0e5c6fd467eed56dff"},
]
pyparsing = []
pytest = []
+pywin32-ctypes = [
+ {file = "pywin32-ctypes-0.2.0.tar.gz", hash = "sha256:24ffc3b341d457d48e8922352130cf2644024a4ff09762a2261fd34c36ee5942"},
+ {file = "pywin32_ctypes-0.2.0-py2.py3-none-any.whl", hash = "sha256:9dc2d991b3479cc2df15930958b674a48a227d5361d413827a4cfd0b5876fc98"},
+]
+readme-renderer = []
+requests = []
+requests-toolbelt = [
+ {file = "requests-toolbelt-0.9.1.tar.gz", hash = "sha256:968089d4584ad4ad7c171454f0a5c6dac23971e9472521ea3b6d49d610aa6fc0"},
+ {file = "requests_toolbelt-0.9.1-py2.py3-none-any.whl", hash = "sha256:380606e1d10dc85c3bd47bf5a6095f815ec007be7a8b69c878507068df059e6f"},
+]
+rfc3986 = []
+rich = []
+secretstorage = []
+six = [
+ {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
+ {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
+]
+stack-data = []
tomli = [
{file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
{file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
]
traitlets = []
-typed-ast = []
+twine = []
typing-extensions = []
+urllib3 = []
wcwidth = [
{file = "wcwidth-0.2.5-py2.py3-none-any.whl", hash = "sha256:beb4802a9cebb9144e99086eff703a642a13d6a0052920003a230f3294bbe784"},
{file = "wcwidth-0.2.5.tar.gz", hash = "sha256:c4d647b99872929fdb7bdcaa4fbe7f01413ed3d98077df798530e5b04f116c83"},
]
+webencodings = [
+ {file = "webencodings-0.5.1-py2.py3-none-any.whl", hash = "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78"},
+ {file = "webencodings-0.5.1.tar.gz", hash = "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923"},
+]
windows-curses = [
{file = "windows_curses-2.3.0-cp310-cp310-win32.whl", hash = "sha256:a3a63a0597729e10f923724c2cf972a23ea677b400d2387dee1d668cf7116177"},
{file = "windows_curses-2.3.0-cp310-cp310-win_amd64.whl", hash = "sha256:7a35eda4cb120b9e1a5ae795f3bc06c55b92c9d391baba6be1903285a05f3551"},
diff --git a/pyproject.toml b/pyproject.toml
index 41b3483..e567d3e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,37 +1,48 @@
[tool.poetry]
name = "epy-reader"
-version = "2022.9.24"
-description = "CLI Ebook Reader"
+version = "2022.10.2"
+description = "TUI Ebook Reader"
authors = ["Benawi Adha <benawiadha@gmail.com>"]
license = "GPL-3.0"
+readme = "README.md"
+repository = "https://github.com/wustho/epy"
+keywords = ["ebook", "epub", "epub3", "fb2", "mobi", "azw3", "TUI", "ebook reader"]
packages = [
- { include = "epy.py" },
- { include = "epy_extras" },
+ { include = "epy_reader", from = "src" }
]
[tool.poetry.scripts]
-epy = "epy:main"
+epy = "epy_reader.__main__:main"
[tool.poetry.dependencies]
-python = "^3.7"
+python = "^3.8"
windows-curses = { version = "*", markers = "platform_system == 'Windows'" }
[tool.poetry.dev-dependencies]
-black = "*"
-coverage = "*"
-debugpy = "*"
-ipython = "*"
-mypy = "*"
-pynvim = "*"
-pytest = "*"
+pynvim = "^0.4.3"
+black = "^22.8.0"
+coverage = "^6.5.0"
+debugpy = "^1.6.3"
+ipython = "^8.5.0"
+mypy = "^0.981"
+pytest = "^7.1.3"
+isort = "^5.10.1"
+build = "^0.8.0"
+twine = "^4.0.1"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
[tool.mypy]
strict_optional = true
+follow_imports = "silent"
+exclude = ["src/epy_reader/tools/"]
[tool.black]
line-length = 100
target-version = ['py38']
+exclude = "src/epy_reader/tools/"
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"
+[tool.isort]
+skip = "src/epy_reader/tools/"
diff --git a/setup.py b/setup.py
deleted file mode 100644
index 1cade5b..0000000
--- a/setup.py
+++ /dev/null
@@ -1,28 +0,0 @@
-import sys
-from setuptools import setup
-
-with open("README.md", "r") as fh:
- long_description = fh.read()
-
-setup(
- name="epy-reader",
- version="2022.9.24",
- description="Terminal/CLI Ebook (epub, fb2, mobi, azw3) Reader",
- long_description=long_description,
- long_description_content_type="text/markdown",
- url="https://github.com/wustho/epy",
- author="Benawi Adha",
- author_email="benawiadha@gmail.com",
- license="GPL-3.0",
- keywords=["epub", "epub3", "fb2", "mobi", "azw3", "CLI", "Terminal", "Reader"],
- python_requires="~=3.7",
- py_modules=["epy"],
- packages=["epy_extras", "epy_extras.KindleUnpack"],
- entry_points={"console_scripts": ["epy = epy:main"]},
- install_requires=["windows-curses;platform_system=='Windows'"],
- classifiers=[
- "Programming Language :: Python :: 3",
- "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
- "Operating System :: OS Independent",
- ],
-)
diff --git a/src/epy_reader/__init__.py b/src/epy_reader/__init__.py
new file mode 100644
index 0000000..97e99a2
--- /dev/null
+++ b/src/epy_reader/__init__.py
@@ -0,0 +1,5 @@
+__version__ = "2022.10.2"
+__license__ = "GPL-3.0"
+__author__ = "Benawi Adha"
+__email__ = "benawiadha@gmail.com"
+__url__ = "https://github.com/wustho/epy"
diff --git a/src/epy_reader/__main__.py b/src/epy_reader/__main__.py
new file mode 100644
index 0000000..ce7d1b2
--- /dev/null
+++ b/src/epy_reader/__main__.py
@@ -0,0 +1,23 @@
+import curses
+import multiprocessing
+import sys
+
+import epy_reader.cli as cli
+import epy_reader.reader as reader
+
+
+def main():
+ # On Windows, calling this method is necessary
+ # On Linux/OSX, this method does nothing
+ multiprocessing.freeze_support()
+ filepath, dump_only = cli.find_file()
+ if dump_only:
+ sys.exit(cli.dump_ebook_content(filepath))
+
+ while True:
+ filepath = curses.wrapper(reader.start_reading, filepath)
+
+
+# https://setuptools.pypa.io/en/latest/userguide/entry_point.html
+if __name__ == "__main__":
+ main()
diff --git a/src/epy_reader/board.py b/src/epy_reader/board.py
new file mode 100644
index 0000000..0562d3f
--- /dev/null
+++ b/src/epy_reader/board.py
@@ -0,0 +1,148 @@
+import curses
+import re
+from typing import Optional, Tuple, Union
+
+from epy_reader.models import Direction, InlineStyle, Key, NoUpdate
+from epy_reader.settings import DoubleSpreadPadding
+
+
+class InfiniBoard:
+ """
+ Wrapper for curses screen to render infinite texts.
+ The idea is instead of pre render all the text before reading,
+ this will only renders part of text on demand by which available
+ page on screen.
+
+ And what this does is only drawing text/string on curses screen
+ without .clear() or .refresh() to optimize performance.
+ """
+
+ def __init__(
+ self,
+ screen,
+ text: Tuple[str, ...],
+ textwidth: int = 80,
+ default_style: Tuple[InlineStyle, ...] = tuple(),
+ spread: int = 1,
+ ):
+ self.screen = screen
+ self.screen_rows, self.screen_cols = self.screen.getmaxyx()
+ self.textwidth = textwidth
+ self.x = ((self.screen_cols - self.textwidth) // 2) + 1
+ self.text = text
+ self.total_lines = len(text)
+ self.default_style: Tuple[InlineStyle, ...] = default_style
+ self.temporary_style: Tuple[InlineStyle, ...] = ()
+ self.spread = spread
+
+ if self.spread == 2:
+ self.x = DoubleSpreadPadding.LEFT.value
+ self.x_alt = (
+ DoubleSpreadPadding.LEFT.value + self.textwidth + DoubleSpreadPadding.MIDDLE.value
+ )
+
+ def feed_temporary_style(self, styles: Optional[Tuple[InlineStyle, ...]] = None) -> None:
+ """Reset styling if `styles` is None"""
+ self.temporary_style = styles if styles else ()
+
+ def render_styles(
+ self, row: int, styles: Tuple[InlineStyle, ...] = (), bottom_padding: int = 0
+ ) -> None:
+ for i in styles:
+ if i.row in range(row, row + self.screen_rows - bottom_padding):
+ self.chgat(row, i.row, i.col, i.n_letters, self.screen.getbkgd() | i.attr)
+
+ if self.spread == 2 and i.row in range(
+ row + self.screen_rows - bottom_padding,
+ row + 2 * (self.screen_rows - bottom_padding),
+ ):
+ self.chgat(
+ row,
+ i.row - (self.screen_rows - bottom_padding),
+ -self.x + self.x_alt + i.col,
+ i.n_letters,
+ self.screen.getbkgd() | i.attr,
+ )
+
+ def getch(self) -> Union[NoUpdate, Key]:
+ input = self.screen.getch()
+ if input == -1:
+ return NoUpdate()
+ return Key(input)
+
+ def getbkgd(self):
+ return self.screen.getbkgd()
+
+ def chgat(self, row: int, y: int, x: int, n: int, attr: int) -> None:
+ self.screen.chgat(y - row, self.x + x, n, attr)
+
+ def write(self, row: int, bottom_padding: int = 0) -> None:
+ for n_row in range(min(self.screen_rows - bottom_padding, self.total_lines - row)):
+ text_line = self.text[row + n_row]
+ self.screen.addstr(n_row, self.x, text_line)
+
+ if (
+ self.spread == 2
+ and row + self.screen_rows - bottom_padding + n_row < self.total_lines
+ ):
+ text_line = self.text[row + self.screen_rows - bottom_padding + n_row]
+ # TODO: clean this up
+ if re.search("\\[IMG:[0-9]+\\]", text_line):
+ self.screen.addstr(
+ n_row, self.x_alt, text_line.center(self.textwidth), curses.A_BOLD
+ )
+ else:
+ self.screen.addstr(n_row, self.x_alt, text_line)
+
+ self.render_styles(row, self.default_style, bottom_padding)
+ self.render_styles(row, self.temporary_style, bottom_padding)
+ # self.screen.refresh()
+
+ def write_n(
+ self,
+ row: int,
+ n: int = 1,
+ direction: Direction = Direction.FORWARD,
+ bottom_padding: int = 0,
+ ) -> None:
+ assert n > 0
+ for n_row in range(min(self.screen_rows - bottom_padding, self.total_lines - row)):
+ text_line = self.text[row + n_row]
+ if direction == Direction.FORWARD:
+ # self.screen.addnstr(n_row, self.x + self.textwidth - n, self.text[row+n_row], n)
+ # `+ " " * (self.textwidth - len(self.text[row + n_row]))` is workaround to
+ # to prevent curses trace because not calling screen.clear()
+ self.screen.addnstr(
+ n_row,
+ self.x + self.textwidth - n,
+ text_line + " " * (self.textwidth - len(text_line)),
+ n,
+ )
+
+ if (
+ self.spread == 2
+ and row + self.screen_rows - bottom_padding + n_row < self.total_lines
+ ):
+ text_line_alt = self.text[row + n_row + self.screen_rows - bottom_padding]
+ self.screen.addnstr(
+ n_row,
+ self.x_alt + self.textwidth - n,
+ text_line_alt + " " * (self.textwidth - len(text_line_alt)),
+ n,
+ )
+
+ else:
+ if text_line[self.textwidth - n :]:
+ self.screen.addnstr(n_row, self.x, text_line[self.textwidth - n :], n)
+
+ if (
+ self.spread == 2
+ and row + self.screen_rows - bottom_padding + n_row < self.total_lines
+ ):
+ text_line_alt = self.text[row + n_row + self.screen_rows - bottom_padding]
+ self.screen.addnstr(
+ n_row,
+ self.x_alt,
+ text_line_alt[self.textwidth - n :],
+ n,
+ )
diff --git a/src/epy_reader/cli.py b/src/epy_reader/cli.py
new file mode 100644
index 0000000..e43b51c
--- /dev/null
+++ b/src/epy_reader/cli.py
@@ -0,0 +1,171 @@
+import argparse
+import os
+import shutil
+import sys
+import textwrap
+from difflib import SequenceMatcher as SM
+from typing import List, Optional, Tuple
+
+from epy_reader import __version__
+from epy_reader.lib import coerce_to_int, is_url, truncate
+from epy_reader.models import LibraryItem
+from epy_reader.parser import parse_html
+from epy_reader.state import State
+from epy_reader.utils import get_ebook_obj
+
+
+def cleanup_library(state: State) -> None:
+ """Cleanup non-existent file from library"""
+ library_items = state.get_from_history()
+ for item in library_items:
+ if not os.path.isfile(item.filepath) and not is_url(item.filepath):
+ state.delete_from_library(item.filepath)
+
+
+def get_nth_file_from_library(state: State, n) -> Optional[LibraryItem]:
+ library_items = state.get_from_history()
+ try:
+ return library_items[n - 1]
+ except IndexError:
+ return None
+
+
+def get_matching_library_item(
+ state: State, pattern: str, threshold: float = 0.5
+) -> Optional[LibraryItem]:
+ matches: List[Tuple[LibraryItem, float]] = [] # [(library_item, match_value), ...]
+ library_items = state.get_from_history()
+ if not library_items:
+ return None
+
+ for item in library_items:
+ tomatch = f"{item.title} - {item.author}" # item.filepath
+ match_value = sum(
+ [i.size for i in SM(None, tomatch.lower(), pattern.lower()).get_matching_blocks()]
+ ) / float(len(pattern))
+ matches.append(
+ (
+ item,
+ match_value,
+ )
+ )
+
+ sorted_matches = sorted(matches, key=lambda x: -x[1])
+ first_match_item, first_match_value = sorted_matches[0]
+ if first_match_item and first_match_value >= threshold:
+ return first_match_item
+ else:
+ return None
+
+
+def print_reading_history(state: State) -> None:
+ termc, _ = shutil.get_terminal_size()
+ library_items = state.get_from_history()
+ if not library_items:
+ print("No Reading History.")
+ return
+
+ print("Reading History:")
+ dig = len(str(len(library_items) + 1))
+ tcols = termc - dig - 2
+ for n, item in enumerate(library_items):
+ print(
+ "{} {}".format(
+ str(n + 1).rjust(dig),
+ truncate(str(item), "...", tcols, tcols - 3),
+ )
+ )
+
+
+def parse_cli_args() -> argparse.Namespace:
+ prog = "epy"
+ positional_arg_help_str = "[PATH | # | PATTERN | URL]"
+ args_parser = argparse.ArgumentParser(
+ prog=prog,
+ usage=f"%(prog)s [-h] [-r] [-d] [-v] {positional_arg_help_str}",
+ formatter_class=argparse.RawDescriptionHelpFormatter,
+ description="Read ebook in terminal",
+ epilog=textwrap.dedent(
+ f"""\
+ examples:
+ {prog} /path/to/ebook read /path/to/ebook file
+ {prog} 3 read #3 file from reading history
+ {prog} count monte read file matching 'count monte'
+ from reading history
+ """
+ ),
+ )
+ args_parser.add_argument("-r", "--history", action="store_true", help="print reading history")
+ args_parser.add_argument("-d", "--dump", action="store_true", help="dump the content of ebook")
+ args_parser.add_argument(
+ "-v",
+ "--version",
+ action="version",
+ version=f"v{__version__}",
+ help="print version and exit",
+ )
+ args_parser.add_argument(
+ "ebook",
+ action="store",
+ nargs="*",
+ metavar=positional_arg_help_str,
+ help="ebook path, history number, pattern or URL",
+ )
+ return args_parser.parse_args()
+
+
+def find_file() -> Tuple[str, bool]:
+ args = parse_cli_args()
+ state = State()
+ cleanup_library(state)
+
+ if args.history:
+ print_reading_history(state)
+ sys.exit()
+
+ if len(args.ebook) == 0:
+ last_read = state.get_last_read()
+ if last_read:
+ return last_read, args.dump
+ else:
+ sys.exit("ERROR: Found no last read ebook file.")
+
+ elif len(args.ebook) == 1:
+ nth = coerce_to_int(args.ebook[0])
+ if nth is not None:
+ file = get_nth_file_from_library(state, nth)
+ if file:
+ return file.filepath, args.dump
+ else:
+ print(f"ERROR: #{nth} file not found.")
+ print_reading_history(state)
+ sys.exit(1)
+ elif is_url(args.ebook[0]):
+ return args.ebook[0], args.dump
+ elif os.path.isfile(args.ebook[0]):
+ return args.ebook[0], args.dump
+
+ pattern = " ".join(args.ebook)
+ match = get_matching_library_item(state, pattern)
+ if match:
+ return match.filepath, args.dump
+ else:
+ sys.exit("ERROR: Found no matching ebook from history.")
+
+
+def dump_ebook_content(filepath: str) -> None:
+ ebook = get_ebook_obj(filepath)
+ try:
+ try:
+ ebook.initialize()
+ except Exception as e:
+ sys.exit("ERROR: Badly-structured ebook.\n" + str(e))
+ for i in ebook.contents:
+ content = ebook.get_raw_text(i)
+ src_lines = parse_html(content)
+ assert isinstance(src_lines, tuple)
+ # sys.stdout.reconfigure(encoding="utf-8") # Python>=3.7
+ for j in src_lines:
+ sys.stdout.buffer.write((j + "\n\n").encode("utf-8"))
+ finally:
+ ebook.cleanup()
diff --git a/src/epy_reader/config.py b/src/epy_reader/config.py
new file mode 100644
index 0000000..db70a98
--- /dev/null
+++ b/src/epy_reader/config.py
@@ -0,0 +1,80 @@
+import dataclasses
+import json
+import os
+import sys
+from typing import Mapping, Tuple, Union
+
+import epy_reader.settings as settings
+from epy_reader.models import AppData, Key
+
+
+class Config(AppData):
+ def __init__(self):
+ setting_dict = dataclasses.asdict(settings.Settings())
+ keymap_dict = dataclasses.asdict(settings.CfgDefaultKeymaps())
+ keymap_builtin_dict = dataclasses.asdict(settings.CfgBuiltinKeymaps())
+
+ if os.path.isfile(self.filepath):
+ with open(self.filepath) as f:
+ cfg_user = json.load(f)
+ setting_dict = Config.update_dict(setting_dict, cfg_user["Setting"])
+ keymap_dict = Config.update_dict(keymap_dict, cfg_user["Keymap"])
+ else:
+ self.save({"Setting": setting_dict, "Keymap": keymap_dict})
+
+ keymap_dict_tuple = {k: tuple(v) for k, v in keymap_dict.items()}
+ keymap_updated = {
+ k: tuple([Key(i) for i in v])
+ for k, v in Config.update_keys_tuple(keymap_dict_tuple, keymap_builtin_dict).items()
+ }
+
+ if sys.platform == "win32":
+ setting_dict["PageScrollAnimation"] = False
+
+ self.setting = settings.Settings(**setting_dict)
+ self.keymap = settings.Keymap(**keymap_updated)
+ # to build help menu text
+ self.keymap_user_dict = keymap_dict
+
+ @property
+ def filepath(self) -> str:
+ return os.path.join(self.prefix, "configuration.json") if self.prefix else os.devnull
+
+ def save(self, cfg_dict):
+ with open(self.filepath, "w") as file:
+ json.dump(cfg_dict, file, indent=2)
+
+ @staticmethod
+ def update_dict(
+ old_dict: Mapping[str, Union[str, int, bool]],
+ new_dict: Mapping[str, Union[str, int, bool]],
+ place_new=False,
+ ) -> Mapping[str, Union[str, int, bool]]:
+ """Returns a copy of `old_dict` after updating it with `new_dict`"""
+
+ result = {**old_dict}
+ for k, _ in new_dict.items():
+ if k in result:
+ result[k] = new_dict[k]
+ elif place_new:
+ result[k] = new_dict[k]
+
+ return result
+
+ @staticmethod
+ def update_keys_tuple(
+ old_keys: Mapping[str, Tuple[str, ...]],
+ new_keys: Mapping[str, Tuple[str, ...]],
+ place_new: bool = False,
+ ) -> Mapping[str, Tuple[str, ...]]:
+ """Returns a copy of `old_keys` after updating it with `new_keys`
+ by appending the tuple value and removes duplicate"""
+
+ result = {**old_keys}
+ for k, _ in new_keys.items():
+ if k in result:
+ result[k] = tuple(set(result[k] + new_keys[k]))
+ elif place_new:
+ result[k] = tuple(set(new_keys[k]))
+
+ return result
diff --git a/src/epy_reader/ebooks/__init__.py b/src/epy_reader/ebooks/__init__.py
new file mode 100644
index 0000000..da5cfc0
--- /dev/null
+++ b/src/epy_reader/ebooks/__init__.py
@@ -0,0 +1,15 @@
+__all__ = [
+ "Ebook",
+ "Epub",
+ "FictionBook",
+ "Mobi",
+ "Azw",
+ "URL",
+]
+
+from epy_reader.ebooks.azw import Azw
+from epy_reader.ebooks.base import Ebook
+from epy_reader.ebooks.epub import Epub
+from epy_reader.ebooks.fictionbook import FictionBook
+from epy_reader.ebooks.mobi import Mobi
+from epy_reader.ebooks.url import URL
diff --git a/src/epy_reader/ebooks/azw.py b/src/epy_reader/ebooks/azw.py
new file mode 100644
index 0000000..139fcc5
--- /dev/null
+++ b/src/epy_reader/ebooks/azw.py
@@ -0,0 +1,26 @@
+import contextlib
+import os
+import shutil
+import tempfile
+import zipfile
+
+from epy_reader.ebooks.epub import Epub
+from epy_reader.tools import unpack_kindle_book
+
+
+class Azw(Epub):
+ def __init__(self, fileepub):
+ self.path = os.path.abspath(fileepub)
+ self.tmpdir = tempfile.mkdtemp(prefix="epy-")
+ basename, _ = os.path.splitext(os.path.basename(self.path))
+ self.tmpepub = os.path.join(self.tmpdir, "mobi8", basename + ".epub")
+
+ def initialize(self):
+ with contextlib.redirect_stdout(None):
+ unpack_kindle_book(self.path, self.tmpdir, epubver="A", use_hd=True)
+ self.file = zipfile.ZipFile(self.tmpepub, "r")
+ Epub.initialize(self)
+
+ def cleanup(self) -> None:
+ shutil.rmtree(self.tmpdir)
+ return
diff --git a/src/epy_reader/ebooks/base.py b/src/epy_reader/ebooks/base.py
new file mode 100644
index 0000000..0869db9
--- /dev/null
+++ b/src/epy_reader/ebooks/base.py
@@ -0,0 +1,48 @@
+import xml.etree.ElementTree as ET
+from typing import Tuple, Union
+
+from epy_reader.models import BookMetadata, TocEntry
+
+
+class Ebook:
+ def __init__(self, fileepub: str):
+ raise NotImplementedError("Ebook.__init__() not implemented")
+
+ @property
+ def path(self) -> str:
+ return self._path
+
+ @path.setter
+ def path(self, value: str) -> None:
+ self._path = value
+
+ @property
+ def contents(self) -> Union[Tuple[str, ...], Tuple[ET.Element, ...]]:
+ return self._contents
+
+ @contents.setter
+ def contents(self, value: Union[Tuple[str, ...], Tuple[ET.Element, ...]]) -> None:
+ self._contents = value
+
+ @property
+ def toc_entries(self) -> Tuple[TocEntry, ...]:
+ return self._toc_entries
+
+ @toc_entries.setter
+ def toc_entries(self, value: Tuple[TocEntry, ...]) -> None:
+ self._toc_entries = value
+
+ def get_meta(self) -> BookMetadata:
+ raise NotImplementedError("Ebook.get_meta() not implemented")
+
+ def initialize(self) -> None:
+ raise NotImplementedError("Ebook.initialize() not implemented")
+
+ def get_raw_text(self, content: Union[str, ET.Element]) -> str:
+ raise NotImplementedError("Ebook.get_raw_text() not implemented")
+
+ def get_img_bytestr(self, impath: str) -> Tuple[str, bytes]:
+ raise NotImplementedError("Ebook.get_img_bytestr() not implemented")
+
+ def cleanup(self) -> None:
+ raise NotImplementedError("Ebook.cleanup() not implemented")
diff --git a/src/epy_reader/ebooks/epub.py b/src/epy_reader/ebooks/epub.py
new file mode 100644
index 0000000..a8cf0fa
--- /dev/null
+++ b/src/epy_reader/ebooks/epub.py
@@ -0,0 +1,202 @@
+import dataclasses
+import os
+import xml.etree.ElementTree as ET
+import zipfile
+import zlib
+from typing import Dict, List, Optional, Sequence, Tuple, Union
+from urllib.parse import unquote, urljoin
+
+from epy_reader.ebooks.base import Ebook
+from epy_reader.models import BookMetadata, TocEntry
+
+
+# TODO: to be deprecated
+DEBUG = False
+
+
+class Epub(Ebook):
+ NAMESPACE = {
+ "DAISY": "http://www.daisy.org/z3986/2005/ncx/",
+ "OPF": "http://www.idpf.org/2007/opf",
+ "CONT": "urn:oasis:names:tc:opendocument:xmlns:container",
+ "XHTML": "http://www.w3.org/1999/xhtml",
+ "EPUB": "http://www.idpf.org/2007/ops",
+ # Dublin Core
+ "DC": "http://purl.org/dc/elements/1.1/",
+ }
+
+ def __init__(self, fileepub: str):
+ self.path: str = os.path.abspath(fileepub)
+ self.file: Union[zipfile.ZipFile, str] = zipfile.ZipFile(fileepub, "r")
+
+ # populate these attributes
+ # by calling self.initialize()
+ self.root_filepath: str
+ self.root_dirpath: str
+
+ def get_meta(self) -> BookMetadata:
+ assert isinstance(self.file, zipfile.ZipFile)
+ # why self.file.read(self.root_filepath) problematic
+ # content_opf = ET.fromstring(self.file.open(self.root_filepath).read())
+ content_opf = ET.parse(self.file.open(self.root_filepath))
+ return Epub._get_metadata(content_opf)
+
+ @staticmethod
+ def _get_metadata(content_opf: ET.ElementTree) -> BookMetadata:
+ metadata: Dict[str, Optional[str]] = {}
+ for field in dataclasses.fields(BookMetadata):
+ element = content_opf.find(f".//DC:{field.name}", Epub.NAMESPACE)
+ if element is not None:
+ metadata[field.name] = element.text
+
+ return BookMetadata(**metadata)
+
+ @staticmethod
+ def _get_contents(content_opf: ET.ElementTree) -> Tuple[str, ...]:
+ # cont = ET.parse(self.file.open(self.root_filepath)).getroot()
+ manifests: List[Tuple[str, str]] = []
+ for manifest_elem in content_opf.findall("OPF:manifest/*", Epub.NAMESPACE):
+ # EPUB3
+ # if manifest_elem.get("id") != "ncx" and manifest_elem.get("properties") != "nav":
+ if (
+ manifest_elem.get("media-type") != "application/x-dtbncx+xml"
+ and manifest_elem.get("properties") != "nav"
+ ):
+ manifest_id = manifest_elem.get("id")
+ assert manifest_id is not None
+ manifest_href = manifest_elem.get("href")
+ assert manifest_href is not None
+ manifests.append((manifest_id, manifest_href))
+
+ spines: List[str] = []
+ contents: List[str] = []
+ for spine_elem in content_opf.findall("OPF:spine/*", Epub.NAMESPACE):
+ idref = spine_elem.get("idref")
+ assert idref is not None
+ spines.append(idref)
+ for spine in spines:
+ for manifest in manifests:
+ if spine == manifest[0]:
+ # book_contents.append(root_dirpath + unquote(manifest[1]))
+ contents.append(unquote(manifest[1]))
+ manifests.remove(manifest)
+ # TODO: test is break necessary
+ break
+
+ return tuple(contents)
+
+ @staticmethod
+ def _get_tocs(toc: ET.Element, version: str, contents: Sequence[str]) -> Tuple[TocEntry, ...]:
+ try:
+ # EPUB3
+ if version in {"1.0", "2.0"}:
+ navPoints = toc.findall("DAISY:navMap//DAISY:navPoint", Epub.NAMESPACE)
+ elif version == "3.0":
+ navPoints = toc.findall(
+ "XHTML:body//XHTML:nav[@EPUB:type='toc']//XHTML:a", Epub.NAMESPACE
+ )
+
+ toc_entries: List[TocEntry] = []
+ for navPoint in navPoints:
+ if version in {"1.0", "2.0"}:
+ src_elem = navPoint.find("DAISY:content", Epub.NAMESPACE)
+ assert src_elem is not None
+ src = src_elem.get("src")
+
+ name_elem = navPoint.find("DAISY:navLabel/DAISY:text", Epub.NAMESPACE)
+ assert name_elem is not None
+ name = name_elem.text
+ elif version == "3.0":
+ src_elem = navPoint
+ assert src_elem is not None
+ src = src_elem.get("href")
+
+ name = "".join(list(navPoint.itertext()))
+
+ assert src is not None
+ src_id = src.split("#")
+
+ try:
+ idx = contents.index(unquote(src_id[0]))
+ except ValueError:
+ continue
+
+ # assert name is not None
+ # NOTE: skip empty label
+ if name is not None:
+ toc_entries.append(
+ TocEntry(
+ label=name,
+ content_index=idx,
+ section=src_id[1] if len(src_id) == 2 else None,
+ )
+ )
+ except AttributeError as e:
+ # TODO:
+ if DEBUG:
+ raise e
+
+ return tuple(toc_entries)
+
+ def initialize(self) -> None:
+ assert isinstance(self.file, zipfile.ZipFile)
+
+ container = ET.parse(self.file.open("META-INF/container.xml"))
+ rootfile_elem = container.find("CONT:rootfiles/CONT:rootfile", Epub.NAMESPACE)
+ assert rootfile_elem is not None
+ self.root_filepath = rootfile_elem.attrib["full-path"]
+ self.root_dirpath = (
+ os.path.dirname(self.root_filepath) + "/"
+ if os.path.dirname(self.root_filepath) != ""
+ else ""
+ )
+
+ content_opf = ET.parse(self.file.open(self.root_filepath))
+ version = content_opf.getroot().get("version")
+
+ contents = Epub._get_contents(content_opf)
+ self.contents = tuple(urljoin(self.root_dirpath, content) for content in contents)
+
+ if version in {"1.0", "2.0"}:
+ # "OPF:manifest/*[@id='ncx']"
+ relative_toc = content_opf.find(
+ "OPF:manifest/*[@media-type='application/x-dtbncx+xml']", Epub.NAMESPACE
+ )
+ elif version == "3.0":
+ relative_toc = content_opf.find("OPF:manifest/*[@properties='nav']", Epub.NAMESPACE)
+ else:
+ raise RuntimeError(f"Unsupported Epub version: {version}")
+ assert relative_toc is not None
+ relative_toc_path = relative_toc.get("href")
+ assert relative_toc_path is not None
+ toc_path = self.root_dirpath + relative_toc_path
+ toc = ET.parse(self.file.open(toc_path)).getroot()
+ self.toc_entries = Epub._get_tocs(toc, version, contents) # *self.contents (absolute path)
+
+ def get_raw_text(self, content_path: Union[str, ET.Element]) -> str:
+ assert isinstance(self.file, zipfile.ZipFile)
+ assert isinstance(content_path, str)
+
+ max_tries: Optional[int] = None # 1 if DEBUG else None
+
+ # use try-except block to catch
+ # zlib.error: Error -3 while decompressing data: invalid distance too far back
+ # seems like caused by multiprocessing
+ tries = 0
+ while True:
+ try:
+ content = self.file.open(content_path).read()
+ break
+ except zlib.error as e:
+ tries += 1
+ if max_tries is not None and tries >= max_tries:
+ raise e
+
+ return content.decode("utf-8")
+
+ def get_img_bytestr(self, impath: str) -> Tuple[str, bytes]:
+ assert isinstance(self.file, zipfile.ZipFile)
+ return impath, self.file.read(impath)
+
+ def cleanup(self) -> None:
+ pass
diff --git a/src/epy_reader/ebooks/fictionbook.py b/src/epy_reader/ebooks/fictionbook.py
new file mode 100644
index 0000000..35611b2
--- /dev/null
+++ b/src/epy_reader/ebooks/fictionbook.py
@@ -0,0 +1,76 @@
+import base64
+import os
+import xml.etree.ElementTree as ET
+from typing import List, Tuple, Union
+
+from epy_reader.ebooks import Ebook
+from epy_reader.models import BookMetadata, TocEntry
+
+
+class FictionBook(Ebook):
+ NAMESPACE = {"FB2": "http://www.gribuser.ru/xml/fictionbook/2.0"}
+
+ def __init__(self, filefb: str):
+ self.path = os.path.abspath(filefb)
+ self.file = filefb
+
+ # populate these attribute
+ # by calling self.initialize()
+ self.root: ET.Element
+
+ def get_meta(self) -> BookMetadata:
+ title_elem = self.root.find(".//FB2:book-title", FictionBook.NAMESPACE)
+ first_name_elem = self.root.find(".//FB2:first-name", FictionBook.NAMESPACE)
+ last_name_elem = self.root.find(".//FB2:last-name", FictionBook.NAMESPACE)
+ date_elem = self.root.find(".//FB2:date", FictionBook.NAMESPACE)
+ identifier_elem = self.root.find(".//FB2:id", FictionBook.NAMESPACE)
+
+ author = first_name_elem.text if first_name_elem is not None else None
+ if last_name_elem is not None:
+ if author is not None and author != "":
+ author += f" {last_name_elem.text}"
+ else:
+ author = last_name_elem.text
+
+ return BookMetadata(
+ title=title_elem.text if title_elem is not None else None,
+ creator=author,
+ date=date_elem.text if date_elem is not None else None,
+ identifier=identifier_elem.text if identifier_elem is not None else None,
+ )
+
+ def initialize(self) -> None:
+ cont = ET.parse(self.file)
+ self.root = cont.getroot()
+
+ self.contents = tuple(self.root.findall("FB2:body/*", FictionBook.NAMESPACE))
+
+ # TODO
+ toc_entries: List[TocEntry] = []
+ for n, i in enumerate(self.contents):
+ title = i.find("FB2:title", FictionBook.NAMESPACE)
+ if title is not None:
+ toc_entries.append(
+ TocEntry(label="".join(title.itertext()), content_index=n, section=None)
+ )
+ self.toc_entries = tuple(toc_entries)
+
+ def get_raw_text(self, node: Union[str, ET.Element]) -> str:
+ assert isinstance(node, ET.Element)
+ ET.register_namespace("", "http://www.gribuser.ru/xml/fictionbook/2.0")
+ # sys.exit(ET.tostring(node, encoding="utf8", method="html").decode("utf-8").replace("ns1:",""))
+ return ET.tostring(node, encoding="utf8", method="html").decode("utf-8").replace("ns1:", "")
+
+ def get_img_bytestr(self, imgid: str) -> Tuple[str, bytes]:
+ # TODO: test if image works
+ imgid = imgid.replace("#", "")
+ img_elem = self.root.find("*[@id='{}']".format(imgid))
+ assert img_elem is not None
+ imgtype = img_elem.get("content-type")
+ img_elem_text = img_elem.text
+ assert imgtype is not None
+ assert img_elem_text is not None
+ return imgid + "." + imgtype.split("/")[1], base64.b64decode(img_elem_text)
+
+ def cleanup(self) -> None:
+ return
diff --git a/src/epy_reader/ebooks/mobi.py b/src/epy_reader/ebooks/mobi.py
new file mode 100644
index 0000000..39f3be4
--- /dev/null
+++ b/src/epy_reader/ebooks/mobi.py
@@ -0,0 +1,69 @@
+import contextlib
+import os
+import shutil
+import tempfile
+import xml.etree.ElementTree as ET
+from typing import Tuple, Union
+
+from epy_reader.ebooks.epub import Epub
+from epy_reader.models import BookMetadata
+from epy_reader.tools import unpack_kindle_book
+
+
+class Mobi(Epub):
+ def __init__(self, filemobi: str):
+ self.path = os.path.abspath(filemobi)
+ self.file = tempfile.mkdtemp(prefix="epy-")
+
+ # populate these attribute
+ # by calling self.initialize()
+ self.root_filepath: str
+ self.root_dirpath: str
+
+ def get_meta(self) -> BookMetadata:
+ # why self.file.read(self.root_filepath) problematic
+ with open(os.path.join(self.root_dirpath, "content.opf")) as f:
+ content_opf = ET.parse(f) # .getroot()
+ return Epub._get_metadata(content_opf)
+
+ def initialize(self) -> None:
+ assert isinstance(self.file, str)
+
+ with contextlib.redirect_stdout(None):
+ unpack_kindle_book(self.path, self.file, epubver="A", use_hd=True)
+ # TODO: add cleanup here
+
+ self.root_dirpath = os.path.join(self.file, "mobi7")
+ self.toc_path = os.path.join(self.root_dirpath, "toc.ncx")
+ version = "2.0"
+
+ with open(os.path.join(self.root_dirpath, "content.opf")) as f:
+ content_opf = ET.parse(f) # .getroot()
+
+ contents = Epub._get_contents(content_opf)
+ self.contents = tuple(os.path.join(self.root_dirpath, content) for content in contents)
+
+ with open(self.toc_path) as f:
+ toc = ET.parse(f).getroot()
+ self.toc_entries = Epub._get_tocs(toc, version, contents) # *self.contents (absolute path)
+
+ def get_raw_text(self, content_path: Union[str, ET.Element]) -> str:
+ assert isinstance(content_path, str)
+ with open(content_path, encoding="utf8") as f:
+ content = f.read()
+ # return content.decode("utf-8")
+ return content
+
+ def get_img_bytestr(self, impath: str) -> Tuple[str, bytes]:
+ # TODO: test on windows
+ # if impath "Images/asdf.png" is problematic
+ image_abspath = os.path.join(self.root_dirpath, impath)
+ image_abspath = os.path.normpath(image_abspath) # handle crossplatform path
+ with open(image_abspath, "rb") as f:
+ src = f.read()
+ return impath, src
+
+ def cleanup(self) -> None:
+ assert isinstance(self.file, str)
+ shutil.rmtree(self.file)
+ return
diff --git a/src/epy_reader/ebooks/url.py b/src/epy_reader/ebooks/url.py
new file mode 100644
index 0000000..4356fa7
--- /dev/null
+++ b/src/epy_reader/ebooks/url.py
@@ -0,0 +1,49 @@
+from pathlib import PurePosixPath
+from typing import Tuple
+from urllib.error import HTTPError, URLError
+from urllib.parse import urljoin, urlparse
+from urllib.request import Request, urlopen
+
+from epy_reader import __version__
+from epy_reader.ebooks import Ebook
+from epy_reader.lib import is_url
+from epy_reader.models import BookMetadata
+
+
+class URL(Ebook):
+ _header = {
+ "User-Agent": f"epy/v{__version__}",
+ "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+ "Accept-Language": "en-US,en;q=0.8",
+ }
+
+ def __init__(self, url: str):
+ self.path = url
+ self.file = url
+ self.contents = ("_",)
+ self.toc_entries = tuple()
+
+ def get_meta(self) -> BookMetadata:
+ return BookMetadata()
+
+ def initialize(self) -> None:
+ try:
+ with urlopen(Request(self.path, headers=URL._header)) as response:
+ self.html = response.read().decode()
+ except HTTPError as e:
+ raise e
+ except URLError as e:
+ raise e
+
+ def get_raw_text(self, _) -> str:
+ return self.html
+
+ def get_img_bytestr(self, src: str) -> Tuple[str, bytes]:
+ image_url = src if is_url(src) else urljoin(self.path, src)
+ # TODO: catch error on request
+ with urlopen(Request(image_url, headers=URL._header)) as response:
+ byte_str = response.read()
+ return PurePosixPath(urlparse(src).path).name, byte_str
+
+ def cleanup(self) -> None:
+ return
diff --git a/src/epy_reader/lib.py b/src/epy_reader/lib.py
new file mode 100644
index 0000000..b010323
--- /dev/null
+++ b/src/epy_reader/lib.py
@@ -0,0 +1,63 @@
+from typing import Any, Optional, Tuple
+from urllib.parse import urljoin, urlparse
+
+
+def is_url(string: str) -> bool:
+ try:
+ tmp = urlparse(string)
+ return all([tmp.scheme, tmp.netloc])
+ except ValueError:
+ return False
+
+
+def coerce_to_int(string: str) -> Optional[int]:
+ try:
+ return int(string)
+ except ValueError:
+ return None
+
+
+def truncate(teks: str, subtitution_text: str, maxlen: int, startsub: int = 0) -> str:
+ """
+ Truncate text
+
+ eg.
+ :param teks: 'This is long silly dummy text'
+ :param subtitution_text: '...'
+ :param maxlen: 12
+ :param startsub: 3
+ :return: 'This...ly dummy text'
+ """
+ if startsub > maxlen:
+ raise ValueError("Var startsub cannot be bigger than maxlen.")
+ elif len(teks) <= maxlen:
+ return teks
+ else:
+ lensu = len(subtitution_text)
+ beg = teks[:startsub]
+ mid = (
+ subtitution_text
+ if lensu <= maxlen - startsub
+ else subtitution_text[: maxlen - startsub]
+ )
+ end = teks[startsub + lensu - maxlen :] if lensu < maxlen - startsub else ""
+ return beg + mid + end
+
+
+def tuple_subtract(tuple_one: Tuple[Any, ...], tuple_two: Tuple[Any, ...]) -> Tuple[Any, ...]:
+ """
+ Returns tuple with members in tuple_one
+ but not in tuple_two
+ """
+ return tuple(i for i in tuple_one if i not in tuple_two)
+
+
+def resolve_path(current_dir: str, relative_path: str) -> str:
+ """
+ Resolve path containing dots
+ eg. '/foo/bar/book.html' + '../img.png' = '/foo/img.png'
+ NOTE: '/' suffix is important to tell that current dir in 'bar'
+ """
+ # can also using os.path.normpath()
+ # but if the image in zipfile then posix path is mandatory
+ return urljoin(current_dir, relative_path)
diff --git a/src/epy_reader/models.py b/src/epy_reader/models.py
new file mode 100644
index 0000000..db4701b
--- /dev/null
+++ b/src/epy_reader/models.py
@@ -0,0 +1,232 @@
+import os
+from dataclasses import dataclass
+from datetime import datetime
+from enum import Enum
+from typing import Any, Mapping, Optional, Tuple, Union
+
+
+class Direction(Enum):
+ FORWARD = "forward"
+ BACKWARD = "backward"
+
+
+@dataclass(frozen=True)
+class BookMetadata:
+ title: Optional[str] = None
+ creator: Optional[str] = None
+ description: Optional[str] = None
+ publisher: Optional[str] = None
+ date: Optional[str] = None
+ language: Optional[str] = None
+ format: Optional[str] = None
+ identifier: Optional[str] = None
+ source: Optional[str] = None
+
+
+@dataclass(frozen=True)
+class LibraryItem:
+ last_read: datetime
+ filepath: str
+ title: Optional[str] = None
+ author: Optional[str] = None
+ reading_progress: Optional[float] = None
+
+ def __str__(self) -> str:
+ if self.reading_progress is None:
+ reading_progress_str = "N/A"
+ else:
+ reading_progress_str = f"{int(self.reading_progress * 100)}%"
+ reading_progress_str = reading_progress_str.rjust(4)
+
+ book_name: str
+ filename = self.filepath.replace(os.path.expanduser("~"), "~", 1)
+ if self.title is not None and self.author is not None:
+ book_name = f"{self.title} - {self.author} ({filename})"
+ elif self.title is None and self.author:
+ book_name = f"{filename} - {self.author}"
+ else:
+ book_name = filename
+
+ last_read_str = self.last_read.strftime("%I:%M%p %b %d")
+
+ return f"{reading_progress_str} {last_read_str}: {book_name}"
+
+
+@dataclass(frozen=True)
+class ReadingState:
+ """
+ Data model for reading state.
+
+ `row` has to be explicitly assigned with value
+ because Seamless feature needs it to adjust from
+ relative (to book's content index) row to absolute
+ (to book's entire content) row.
+
+ `rel_pctg` and `section` default to None and if
+ either of them is assigned with value, then it
+ will be overriding the `row` value.
+ """
+
+ content_index: int
+ textwidth: int
+ row: int
+ rel_pctg: Optional[float] = None
+ section: Optional[str] = None
+
+
+@dataclass(frozen=True)
+class SearchData:
+ direction: Direction = Direction.FORWARD
+ value: str = ""
+
+
+@dataclass(frozen=True)
+class LettersCount:
+ """
+ all: total letters in book
+ cumulative: list of total letters for previous contents
+ eg. let's say cumulative = (0, 50, 89, ...) it means
+ 0 is total cumulative letters of book contents[-1] to contents[0]
+ 50 is total cumulative letters of book contents[0] to contents[1]
+ 89 is total cumulative letters of book contents[0] to contents[2]
+ """
+
+ all: int
+ cumulative: Tuple[int, ...]
+
+
+@dataclass(frozen=True)
+class CharPos:
+ """
+ Describes character position in text.
+ eg. ["Lorem ipsum dolor sit amet,", # row=0
+ "consectetur adipiscing elit."] # row=1
+ ^CharPos(row=1, col=3)
+ """
+
+ row: int
+ col: int
+
+
+@dataclass(frozen=True)
+class TextMark:
+ """
+ Describes marking in text.
+ eg. Interval [CharPos(row=0, col=3), CharPos(row=1, col=4)]
+ notice the marking inclusive [] for both side instead of right exclusive [)
+ """
+
+ start: CharPos
+ end: Optional[CharPos] = None
+
+ def is_valid(self) -> bool:
+ """
+ Assert validity and check if the mark is unterminated
+ eg. <div><i>This is italic text</div>
+ Missing </i> tag
+ """
+ if self.end is not None:
+ if self.start.row == self.end.row:
+ return self.start.col <= self.end.col
+ else:
+ return self.start.row < self.end.row
+
+ return False
+
+
+@dataclass(frozen=True)
+class TextSpan:
+ """
+ Like TextMark but using span of letters (n_letters)
+ """
+
+ start: CharPos
+ n_letters: int
+
+
+@dataclass(frozen=True)
+class InlineStyle:
+ """
+ eg. InlineStyle(attr=curses.A_BOLD, row=3, cols=4, n_letters=3)
+ """
+
+ row: int
+ col: int
+ n_letters: int
+ attr: int
+
+
+@dataclass(frozen=True)
+class TocEntry:
+ label: str
+ content_index: int
+ section: Optional[str]
+
+
+@dataclass(frozen=True)
+class TextStructure:
+ """
+ Object that describes how the text
+ should be displayed in screen.
+
+ text_lines: ("list of lines", "of text", ...)
+ image_maps: {line_num: path/to/image/in/ebook/zip}
+ section_rows: {section_id: line_num}
+ formatting: (InlineStyle, ...)
+ """
+
+ text_lines: Tuple[str, ...]
+ image_maps: Mapping[int, str]
+ section_rows: Mapping[str, int]
+ formatting: Tuple[InlineStyle, ...]
+
+
+@dataclass(frozen=True)
+class NoUpdate:
+ pass
+
+
+class Key:
+ """
+ Because ord("k") chr(34) are confusing
+ """
+
+ def __init__(self, char_or_int: Union[str, int]):
+ self.value: int = char_or_int if isinstance(char_or_int, int) else ord(char_or_int)
+ self.char: str = char_or_int if isinstance(char_or_int, str) else chr(char_or_int)
+
+ def __eq__(self, other: Any) -> bool:
+ if isinstance(other, Key):
+ return self.value == other.value
+ return False
+
+ def __ne__(self, other: Any) -> bool:
+ return self.__eq__(other)
+
+ def __hash__(self) -> int:
+ return hash(self.value)
+
+
+class AppData:
+ @property
+ def prefix(self) -> Optional[str]:
+ """Return None if there exists no homedir | userdir"""
+ prefix: Optional[str] = None
+
+ # UNIX filesystem
+ homedir = os.getenv("HOME")
+ # WIN filesystem
+ userdir = os.getenv("USERPROFILE")
+
+ if homedir:
+ if os.path.isdir(os.path.join(homedir, ".config")):
+ prefix = os.path.join(homedir, ".config", "epy")
+ else:
+ prefix = os.path.join(homedir, ".epy")
+ elif userdir:
+ prefix = os.path.join(userdir, ".epy")
+
+ if prefix:
+ os.makedirs(prefix, exist_ok=True)
+
+ return prefix
diff --git a/src/epy_reader/parser.py b/src/epy_reader/parser.py
new file mode 100644
index 0000000..6eced00
--- /dev/null
+++ b/src/epy_reader/parser.py
@@ -0,0 +1,421 @@
+import curses
+import dataclasses
+import re
+import textwrap
+from html import unescape
+from html.parser import HTMLParser
+from typing import Dict, List, Mapping, Optional, Sequence, Set, Tuple, Union
+from urllib.parse import unquote
+
+from epy_reader.models import CharPos, InlineStyle, TextMark, TextSpan, TextStructure
+
+
+class HTMLtoLines(HTMLParser):
+ para = {"p", "div"}
+ inde = {"q", "dt", "dd", "blockquote"}
+ pref = {"pre"}
+ bull = {"li"}
+ hide = {"script", "style", "head"}
+ ital = {"i", "em"}
+ bold = {"b", "strong"}
+ # hide = {"script", "style", "head", ", "sub}
+ # sup_lookup = "⁰¹²³⁴⁵⁶⁷⁸⁹"
+ # sub_lookup = "₀₁₂₃₄₅₆₇₈₉"
+
+ attr_bold = curses.A_BOLD
+ try:
+ attr_italic = curses.A_ITALIC
+ except AttributeError:
+ try:
+ attr_italic = curses.A_UNDERLINE
+ except AttributeError:
+ attr_italic = curses.A_NORMAL
+
+ @staticmethod
+ def _mark_to_spans(text: Sequence[str], marks: Sequence[TextMark]) -> List[TextSpan]:
+ """
+ Convert text marks in line of text to per line text span.
+ Keeping duplicate spans.
+ """
+ spans: List[TextSpan] = []
+ for mark in marks:
+ if mark.is_valid():
+ # mypy issue, should be handled by mark.is_valid()
+ assert mark.end is not None
+ if mark.start.row == mark.end.row:
+ spans.append(
+ TextSpan(start=mark.start, n_letters=mark.end.col - mark.start.col)
+ )
+ else:
+ spans.append(
+ TextSpan(
+ start=mark.start, n_letters=len(text[mark.start.row]) - mark.start.col
+ )
+ )
+ for nth_line in range(mark.start.row + 1, mark.end.row):
+ spans.append(
+ TextSpan(
+ start=CharPos(row=nth_line, col=0), n_letters=len(text[nth_line])
+ )
+ )
+ spans.append(
+ TextSpan(start=CharPos(row=mark.end.row, col=0), n_letters=mark.end.col)
+ )
+
+ return spans # list(set(spans))
+
+ @staticmethod
+ def _adjust_wrapped_spans(
+ wrapped_lines: Sequence[str],
+ span: TextSpan,
+ *,
+ line_adjustment: int = 0,
+ left_adjustment: int = 0,
+ ) -> List[TextSpan]:
+ """
+ Adjust text span to wrapped lines.
+ Not perfect, but should be good enough considering
+ the limitation on commandline interface.
+ """
+
+ # current_row = span.start.row + line_adjustment
+ current_row = line_adjustment
+ start_col = span.start.col
+ end_col = start_col + span.n_letters
+
+ prev = 0 # chars length before current line
+ spans: List[TextSpan] = []
+ for n, line in enumerate(wrapped_lines):
+ # + 1 compensates textwrap.wrap(*args, replace_whitespace=True, drop_whitespace=True)
+ line_len = len(line) + 1
+ current = prev + line_len # chars length before next line
+
+ # -:unmarked *:marked
+ # |------*****--------|
+ if start_col in range(prev, current) and end_col in range(prev, current):
+ spans.append(
+ TextSpan(
+ start=CharPos(row=current_row + n, col=start_col - prev + left_adjustment),
+ n_letters=span.n_letters,
+ )
+ )
+
+ # |----------*********|
+ elif start_col in range(prev, current):
+ spans.append(
+ TextSpan(
+ start=CharPos(row=current_row + n, col=start_col - prev + left_adjustment),
+ n_letters=current - start_col - 1, # -1: dropped whitespace
+ )
+ )
+
+ # |********-----------|
+ elif end_col in range(prev, current):
+ spans.append(
+ TextSpan(
+ start=CharPos(row=current_row + n, col=0 + left_adjustment),
+ n_letters=end_col - prev + 1, # +1: dropped whitespace
+ )
+ )
+
+ # |*******************|
+ elif prev in range(start_col, end_col) and current in range(start_col, end_col):
+ spans.append(
+ TextSpan(
+ start=CharPos(row=current_row + n, col=0 + left_adjustment),
+ n_letters=line_len - 1, # -1: dropped whitespace
+ )
+ )
+
+ elif prev > end_col:
+ break
+
+ prev = current
+
+ return spans
+
+ @staticmethod
+ def _group_spans_by_row(blocks: Sequence[TextSpan]) -> Mapping[int, List[TextSpan]]:
+ groups: Dict[int, List[TextSpan]] = {}
+ for block in blocks:
+ row = block.start.row
+ if row in groups:
+ groups[row].append(block)
+ else:
+ groups[row] = [block]
+ return groups
+
+ def __init__(self, sects={""}):
+ HTMLParser.__init__(self)
+ self.text = [""]
+ self.ishead = False
+ self.isinde = False
+ self.isbull = False
+ self.ispref = False
+ self.ishidden = False
+ self.idhead = set()
+ self.idinde = set()
+ self.idbull = set()
+ self.idpref = set()
+ self.idimgs = set()
+ self.sects = sects
+ self.sectsindex = {}
+ self.italic_marks: List[TextMark] = []
+ self.bold_marks: List[TextMark] = []
+ self.imgs: Dict[int, str] = dict()
+
+ def handle_starttag(self, tag, attrs):
+ if re.match("h[1-6]", tag) is not None:
+ self.ishead = True
+ elif tag in self.inde:
+ self.isinde = True
+ elif tag in self.pref:
+ self.ispref = True
+ elif tag in self.bull:
+ self.isbull = True
+ elif tag in self.hide:
+ self.ishidden = True
+ elif tag == "sup":
+ self.text[-1] += "^{"
+ elif tag == "sub":
+ self.text[-1] += "_{"
+ # NOTE: "img" and "image"
+ # In HTML, both are startendtag (no need endtag)
+ # but in XHTML both need endtag
+ elif tag in {"img", "image"}:
+ for i in attrs:
+ if (tag == "img" and i[0] == "src") or (tag == "image" and i[0].endswith("href")):
+ this_line = len(self.text)
+ self.idimgs.add(this_line)
+ self.imgs[this_line] = unquote(i[1])
+ self.text.append("[IMAGE]")
+ # formatting
+ elif tag in self.ital:
+ if len(self.italic_marks) == 0 or self.italic_marks[-1].is_valid():
+ char_pos = CharPos(row=len(self.text) - 1, col=len(self.text[-1]))
+ self.italic_marks.append(TextMark(start=char_pos))
+ elif tag in self.bold:
+ if len(self.bold_marks) == 0 or self.bold_marks[-1].is_valid():
+ char_pos = CharPos(row=len(self.text) - 1, col=len(self.text[-1]))
+ self.bold_marks.append(TextMark(start=char_pos))
+ if self.sects != {""}:
+ for i in attrs:
+ if i[0] == "id" and i[1] in self.sects:
+ # self.text[-1] += " (#" + i[1] + ") "
+ # self.sectsindex.append([len(self.text), i[1]])
+ self.sectsindex[len(self.text) - 1] = i[1]
+
+ def handle_startendtag(self, tag, attrs):
+ if tag == "br":
+ self.text += [""]
+ elif tag in {"img", "image"}:
+ for i in attrs:
+ # if (tag == "img" and i[0] == "src")\
+ # or (tag == "image" and i[0] == "xlink:href"):
+ if (tag == "img" and i[0] == "src") or (tag == "image" and i[0].endswith("href")):
+ this_line = len(self.text)
+ self.idimgs.add(this_line)
+ self.imgs[this_line] = unquote(i[1])
+ self.text.append("[IMAGE]")
+ self.text.append("")
+ # sometimes attribute "id" is inside "startendtag"
+ # especially html from mobi module (kindleunpack fork)
+ if self.sects != {""}:
+ for i in attrs:
+ if i[0] == "id" and i[1] in self.sects:
+ # self.text[-1] += " (#" + i[1] + ") "
+ self.sectsindex[len(self.text) - 1] = i[1]
+
+ def handle_endtag(self, tag):
+ if re.match("h[1-6]", tag) is not None:
+ self.text.append("")
+ self.text.append("")
+ self.ishead = False
+ elif tag in self.para:
+ self.text.append("")
+ elif tag in self.hide:
+ self.ishidden = False
+ elif tag in self.inde:
+ if self.text[-1] != "":
+ self.text.append("")
+ self.isinde = False
+ elif tag in self.pref:
+ if self.text[-1] != "":
+ self.text.append("")
+ self.ispref = False
+ elif tag in self.bull:
+ if self.text[-1] != "":
+ self.text.append("")
+ self.isbull = False
+ elif tag in {"sub", "sup"}:
+ self.text[-1] += "}"
+ elif tag in {"img", "image"}:
+ self.text.append("")
+ # formatting
+ elif tag in self.ital:
+ char_pos = CharPos(row=len(self.text) - 1, col=len(self.text[-1]))
+ last_mark = self.italic_marks[-1]
+ self.italic_marks[-1] = dataclasses.replace(last_mark, end=char_pos)
+ elif tag in self.bold:
+ char_pos = CharPos(row=len(self.text) - 1, col=len(self.text[-1]))
+ last_mark = self.bold_marks[-1]
+ self.bold_marks[-1] = dataclasses.replace(last_mark, end=char_pos)
+
+ def handle_data(self, raw):
+ if raw and not self.ishidden:
+ if self.text[-1] == "":
+ tmp = raw.lstrip()
+ else:
+ tmp = raw
+ if self.ispref:
+ line = unescape(tmp)
+ else:
+ line = unescape(re.sub(r"\s+", " ", tmp))
+ self.text[-1] += line
+ if self.ishead:
+ self.idhead.add(len(self.text) - 1)
+ elif self.isbull:
+ self.idbull.add(len(self.text) - 1)
+ elif self.isinde:
+ self.idinde.add(len(self.text) - 1)
+ elif self.ispref:
+ self.idpref.add(len(self.text) - 1)
+
+ def get_structured_text(
+ self, textwidth: Optional[int] = 0, starting_line: int = 0
+ ) -> Union[Tuple[str, ...], TextStructure]:
+
+ if not textwidth:
+ return tuple(self.text)
+
+ text: List[str] = []
+ images: Dict[int, str] = dict() # {line_num: path/in/zip}
+ sect: Dict[str, int] = dict() # {section_id: line_num}
+ formatting: List[InlineStyle] = []
+
+ italic_spans: List[TextSpan] = HTMLtoLines._mark_to_spans(self.text, self.italic_marks)
+ bold_spans: List[TextSpan] = HTMLtoLines._mark_to_spans(self.text, self.bold_marks)
+ italic_groups = HTMLtoLines._group_spans_by_row(italic_spans)
+ bold_groups = HTMLtoLines._group_spans_by_row(bold_spans)
+
+ for n, line in enumerate(self.text):
+
+ startline = len(text)
+ # findsect = re.search(r"(?<= \(#).*?(?=\) )", line)
+ # if findsect is not None and findsect.group() in self.sects:
+ # line = line.replace(" (#" + findsect.group() + ") ", "")
+ # # line = line.replace(" (#" + findsect.group() + ") ", " "*(5+len(findsect.group())))
+ # sect[findsect.group()] = len(text)
+ if n in self.sectsindex.keys():
+ sect[self.sectsindex[n]] = starting_line + len(text)
+ if n in self.idhead:
+ # text += [line.rjust(textwidth // 2 + len(line) // 2)] + [""]
+ text += [line.center(textwidth)] + [""]
+ formatting += [
+ InlineStyle(
+ row=starting_line + i, col=0, n_letters=len(text[i]), attr=self.attr_bold
+ )
+ for i in range(startline, len(text))
+ ]
+ elif n in self.idinde:
+ text += [" " + i for i in textwrap.wrap(line, textwidth - 3)] + [""]
+ elif n in self.idbull:
+ tmp = textwrap.wrap(line, textwidth - 3)
+ text += [" - " + i if i == tmp[0] else " " + i for i in tmp] + [""]
+ elif n in self.idpref:
+ tmp = line.splitlines()
+ wraptmp = []
+ for tmp_line in tmp:
+ wraptmp += [i for i in textwrap.wrap(tmp_line, textwidth - 6)]
+ text += [" " + i for i in wraptmp] + [""]
+ elif n in self.idimgs:
+ images[starting_line + len(text)] = self.imgs[n]
+ text += [line.center(textwidth)]
+ formatting += [
+ InlineStyle(
+ row=starting_line + len(text) - 1,
+ col=0,
+ n_letters=len(text[-1]),
+ attr=self.attr_bold,
+ )
+ ]
+ text += [""]
+ else:
+ text += textwrap.wrap(line, textwidth) + [""]
+
+ endline = len(text) # -1
+
+ left_adjustment = 3 if n in self.idbull | self.idinde else 0
+
+ for spans in italic_groups.get(n, []):
+ italics = HTMLtoLines._adjust_wrapped_spans(
+ text[startline:endline],
+ spans,
+ line_adjustment=startline,
+ left_adjustment=left_adjustment,
+ )
+ for span in italics:
+ formatting.append(
+ InlineStyle(
+ row=starting_line + span.start.row,
+ col=span.start.col,
+ n_letters=span.n_letters,
+ attr=self.attr_italic,
+ )
+ )
+
+ for spans in bold_groups.get(n, []):
+ bolds = HTMLtoLines._adjust_wrapped_spans(
+ text[startline:endline],
+ spans,
+ line_adjustment=startline,
+ left_adjustment=left_adjustment,
+ )
+ for span in bolds:
+ formatting.append(
+ InlineStyle(
+ row=starting_line + span.start.row,
+ col=span.start.col,
+ n_letters=span.n_letters,
+ attr=self.attr_bold,
+ )
+ )
+
+ # chapter suffix
+ text += ["***".center(textwidth)]
+
+ return TextStructure(
+ text_lines=tuple(text),
+ image_maps=images,
+ section_rows=sect,
+ formatting=tuple(formatting),
+ )
+
+
+def parse_html(
+ html_src: str,
+ *,
+ textwidth: Optional[int] = None,
+ section_ids: Optional[Set[str]] = None,
+ starting_line: int = 0,
+) -> Union[Tuple[str, ...], TextStructure]:
+ """
+ Parse html string into TextStructure
+
+ :param html_src: html str to parse
+ :param textwidth: textwidth to count max length of returned TextStructure
+ if None given, sequence of text as paragraph is returned
+ :param section_ids: set of section ids to look for inside html tag attr
+ :return: Tuple[str, ...] if textwidth not given else TextStructure
+ """
+ if not section_ids:
+ section_ids = set()
+
+ parser = HTMLtoLines(section_ids)
+ # try:
+ parser.feed(html_src)
+ parser.close()
+ # except:
+ # pass
+
+ return parser.get_structured_text(textwidth, starting_line)
diff --git a/src/epy_reader/reader.py b/src/epy_reader/reader.py
new file mode 100644
index 0000000..a903b62
--- /dev/null
+++ b/src/epy_reader/reader.py
@@ -0,0 +1,1610 @@
+import curses
+import dataclasses
+import multiprocessing
+import os
+import re
+import shutil
+import signal
+import sqlite3
+import subprocess
+import sys
+import tempfile
+import uuid
+import xml.etree.ElementTree as ET
+from html import unescape
+from typing import Any, Dict, List, Optional, Sequence, Tuple, Union
+
+import epy_reader.settings as settings
+from epy_reader.board import InfiniBoard
+from epy_reader.config import Config
+from epy_reader.ebooks import Azw, Ebook, Epub, Mobi
+from epy_reader.lib import resolve_path
+from epy_reader.models import (
+ Direction,
+ InlineStyle,
+ Key,
+ LettersCount,
+ NoUpdate,
+ ReadingState,
+ SearchData,
+ TextStructure,
+ TocEntry,
+)
+from epy_reader.parser import parse_html
+from epy_reader.settings import DoubleSpreadPadding
+from epy_reader.speakers import SpeakerBaseModel
+from epy_reader.state import State
+from epy_reader.utils import (
+ choice_win,
+ construct_relative_reading_state,
+ construct_speaker,
+ count_letters,
+ count_letters_parallel,
+ find_current_content_index,
+ get_ebook_obj,
+ merge_text_structures,
+ pgend,
+ safe_curs_set,
+ text_win,
+)
+
+
+# TODO: to be deprecated
+DEBUG = False
+
+
+class Reader:
+ def __init__(self, screen, ebook: Ebook, config: Config, state: State):
+
+ self.setting = config.setting
+ self.keymap = config.keymap
+ # to build help menu text
+ self.keymap_user_dict = config.keymap_user_dict
+
+ self.seamless = self.setting.SeamlessBetweenChapters
+
+ # keys that will make
+ # windows exit and return the said key
+ self._win_keys = (
+ # curses.KEY_RESIZE is a must
+ (Key(curses.KEY_RESIZE),)
+ + self.keymap.TableOfContents
+ + self.keymap.Metadata
+ + self.keymap.Help
+ )
+
+ # screen initialization
+ self.screen = screen
+ self.screen.keypad(True)
+ safe_curs_set(0)
+ if self.setting.MouseSupport:
+ curses.mousemask(-1)
+ # curses.mouseinterval(0)
+ self.screen.clear()
+
+ # screen color
+ self.is_color_supported: bool = False
+ try:
+ curses.use_default_colors()
+ curses.init_pair(1, self.setting.DefaultColorFG, self.setting.DefaultColorBG)
+ curses.init_pair(2, self.setting.DarkColorFG, self.setting.DarkColorBG)
+ curses.init_pair(3, self.setting.LightColorFG, self.setting.LightColorBG)
+ self.screen.bkgd(curses.color_pair(1))
+ self.is_color_supported = True
+ except:
+ self.is_color_supported = False
+
+ # show loader and start heavy resources processes
+ self.show_loader(subtext="initalizing ebook")
+
+ # main ebook object
+ self.ebook = ebook
+ try:
+ self.ebook.initialize()
+ except (KeyboardInterrupt, Exception) as e:
+ self.ebook.cleanup()
+ if DEBUG:
+ raise e
+ else:
+ sys.exit("ERROR: Badly-structured ebook.\n" + str(e))
+
+ # state
+ self.state = state
+
+ # page scroll animation
+ self.page_animation: Optional[Direction] = None
+
+ # show reading progress
+ self.show_reading_progress: bool = self.setting.ShowProgressIndicator
+ self.reading_progress: Optional[float] = None # calculate after count_letters()
+
+ # search storage
+ self.search_data: Optional[SearchData] = None
+
+ # double spread
+ self.spread = 2 if self.setting.StartWithDoubleSpread else 1
+
+ # jumps marker container
+ self.jump_list: Dict[str, ReadingState] = dict()
+
+ # TTS speaker utils
+ self._tts_speaker: Optional[SpeakerBaseModel] = construct_speaker(
+ self.setting.PreferredTTSEngine, self.setting.TTSEngineArgs
+ )
+ self.tts_support: bool = bool(self._tts_speaker)
+ self.is_speaking: bool = False
+
+ # multi process & progress percentage
+ self._multiprocess_support: bool = False if multiprocessing.cpu_count() == 1 else True
+ self._process_counting_letter: Optional[multiprocessing.Process] = None
+ self.letters_count: Optional[LettersCount] = None
+
+ def run_counting_letters(self):
+ if self._multiprocess_support:
+ try:
+ self._proc_parent, self._proc_child = multiprocessing.Pipe()
+ self._process_counting_letter = multiprocessing.Process(
+ name="epy-subprocess-counting-letters",
+ target=count_letters_parallel,
+ args=(self.ebook, self._proc_child),
+ )
+ # forking will raise
+ # zlib.error: Error -3 while decompressing data: invalid distance too far back
+ self._process_counting_letter.start()
+ except Exception as e:
+ if DEBUG:
+ raise e
+ self._multiprocess_support = False
+ if not self._multiprocess_support:
+ self.letters_count = count_letters(self.ebook)
+
+ def try_assign_letters_count(self, *, force_wait=False) -> None:
+ if isinstance(self._process_counting_letter, multiprocessing.Process):
+ if force_wait and self._process_counting_letter.is_alive():
+ self._process_counting_letter.join()
+
+ if self._process_counting_letter.exitcode == 0:
+ self.letters_count = self._proc_parent.recv()
+ self._proc_parent.close()
+ self._process_counting_letter.terminate()
+ self._process_counting_letter.close()
+ self._process_counting_letter = None
+
+ def calculate_reading_progress(
+ self, letters_per_content: List[int], reading_state: ReadingState
+ ) -> None:
+ if self.letters_count:
+ self.reading_progress = (
+ self.letters_count.cumulative[reading_state.content_index]
+ + sum(
+ letters_per_content[: reading_state.row + (self.screen_rows * self.spread) - 1]
+ )
+ ) / self.letters_count.all
+
+ @property
+ def screen_rows(self) -> int:
+ return self.screen.getmaxyx()[0]
+
+ @property
+ def screen_cols(self) -> int:
+ return self.screen.getmaxyx()[1]
+
+ @property
+ def ext_dict_app(self) -> Optional[str]:
+ self._ext_dict_app: Optional[str] = None
+
+ if shutil.which(self.setting.DictionaryClient.split()[0]):
+ self._ext_dict_app = self.setting.DictionaryClient
+ else:
+ for i in settings.DICT_PRESET_LIST:
+ if shutil.which(i) is not None:
+ self._ext_dict_app = i
+ break
+ if self._ext_dict_app in {"sdcv"}:
+ self._ext_dict_app += " -n"
+
+ return self._ext_dict_app
+
+ @property
+ def image_viewer(self) -> Optional[str]:
+ self._image_viewer: Optional[str] = None
+
+ if shutil.which(self.setting.DefaultViewer.split()[0]) is not None:
+ self._image_viewer = self.setting.DefaultViewer
+ elif sys.platform == "win32":
+ self._image_viewer = "start"
+ elif sys.platform == "darwin":
+ self._image_viewer = "open"
+ else:
+ for i in settings.VIEWER_PRESET_LIST:
+ if shutil.which(i) is not None:
+ self._image_viewer = i
+ break
+
+ if self._image_viewer in {"gio"}:
+ self._image_viewer += " open"
+
+ return self._image_viewer
+
+ def open_image(self, pad, name, bstr):
+ sfx = os.path.splitext(name)[1]
+ fd, path = tempfile.mkstemp(suffix=sfx)
+ try:
+ with os.fdopen(fd, "wb") as tmp:
+ # tmp.write(epub.file.read(src))
+ tmp.write(bstr)
+ # run(VWR + " " + path, shell=True)
+ subprocess.call(
+ self.image_viewer + " " + path,
+ shell=True,
+ stdout=subprocess.DEVNULL,
+ stderr=subprocess.DEVNULL,
+ )
+ k = pad.getch()
+ finally:
+ os.remove(path)
+ return k
+
+ def show_loader(self, *, loader_str: str = "\u231B", subtext: Optional[str] = None):
+ self.screen.clear()
+ rows, cols = self.screen.getmaxyx()
+ middle_row = (rows - 1) // 2
+ self.screen.addstr(middle_row, 0, loader_str.center(cols))
+ if subtext:
+ self.screen.addstr(middle_row + 1, 0, subtext.center(cols))
+ # self.screen.addstr(((rows-2)//2)+1, (cols-len(msg))//2, msg)
+ self.screen.refresh()
+
+ @choice_win(True)
+ def show_win_options(self, title, options, active_index, key_set):
+ return title, options, active_index, key_set
+
+ @text_win
+ def show_win_error(self, title, msg, key):
+ return title, msg, key
+
+ @choice_win()
+ def toc(self, toc_entries: Tuple[TocEntry, ...], index: int):
+ return (
+ "Table of Contents",
+ [i.label for i in toc_entries],
+ index,
+ self.keymap.TableOfContents,
+ )
+
+ @text_win
+ def show_win_metadata(self):
+ if os.path.isfile(self.ebook.path):
+ mdata = "[File Info]\nPATH: {}\nSIZE: {} MB\n \n[Book Info]\n".format(
+ self.ebook.path, round(os.path.getsize(self.ebook.path) / 1024**2, 2)
+ )
+ else:
+ mdata = "[File Info]\nPATH: {}\n \n[Book Info]\n".format(self.ebook.path)
+
+ book_metadata = self.ebook.get_meta()
+ for field in dataclasses.fields(book_metadata):
+ value = getattr(book_metadata, field.name)
+ if value:
+ value = unescape(re.sub("<[^>]*>", "", value))
+ mdata += f"{field.name.title()}: {value}\n"
+
+ return "Metadata", mdata, self.keymap.Metadata
+
+ @text_win
+ def show_win_help(self):
+ src = "Key Bindings:\n"
+ dig = max([len(i) for i in self.keymap_user_dict.values()]) + 2
+ for i in self.keymap_user_dict.keys():
+ src += "{} {}\n".format(
+ self.keymap_user_dict[i].rjust(dig), " ".join(re.findall("[A-Z][^A-Z]*", i))
+ )
+ return "Help", src, self.keymap.Help
+
+ @text_win
+ def define_word(self, word):
+ rows, cols = self.screen.getmaxyx()
+ hi, wi = 5, 16
+ Y, X = (rows - hi) // 2, (cols - wi) // 2
+
+ p = subprocess.Popen(
+ "{} {}".format(self.ext_dict_app, word),
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE,
+ shell=True,
+ )
+
+ dictwin = curses.newwin(hi, wi, Y, X)
+ dictwin.box()
+ dictwin.addstr((hi - 1) // 2, (wi - 10) // 2, "Loading...")
+ dictwin.refresh()
+
+ out, err = p.communicate()
+
+ dictwin.clear()
+ dictwin.refresh()
+
+ if err == b"":
+ return "Definition: " + word.upper(), out.decode(), self.keymap.DefineWord
+ else:
+ return "Error: " + self.ext_dict_app, err.decode(), self.keymap.DefineWord
+
+ def show_win_choices_bookmarks(self):
+ idx = 0
+ while True:
+ bookmarks = [i[0] for i in self.state.get_bookmarks(self.ebook)]
+ if not bookmarks:
+ return self.keymap.ShowBookmarks[0], None
+
+ retk, idx, todel = self.show_win_options(
+ "Bookmarks", bookmarks, idx, self.keymap.ShowBookmarks
+ )
+ if todel is not None:
+ self.state.delete_bookmark(self.ebook, bookmarks[todel])
+ else:
+ return retk, idx
+
+ def show_win_library(self):
+ while True:
+ library_items = self.state.get_from_history()
+ if not library_items:
+ return self.keymap.Library[0], None
+
+ retk, choice_index, todel_index = self.show_win_options(
+ "Library", [str(item) for item in library_items], 0, self.keymap.Library
+ )
+ if todel_index is not None:
+ self.state.delete_from_library(library_items[todel_index].filepath)
+ else:
+ return retk, choice_index
+
+ def input_prompt(self, prompt: str) -> Union[NoUpdate, Key, str]:
+ """
+ :param prompt: prompt text
+ :return: NoUpdate if cancelled or interrupted
+ Key if curses.KEY_RESIZE triggered
+ str for successful input
+ """
+ # prevent pad hole when prompting for input while
+ # other window is active
+ # pad.refresh(y, 0, 0, x, rows-2, x+width)
+ rows, cols = self.screen.getmaxyx()
+ stat = curses.newwin(1, cols, rows - 1, 0)
+ if self.is_color_supported:
+ stat.bkgd(self.screen.getbkgd())
+ stat.keypad(True)
+ curses.echo(True)
+ safe_curs_set(2)
+
+ init_text = ""
+
+ stat.addstr(0, 0, prompt, curses.A_REVERSE)
+ stat.addstr(0, len(prompt), init_text)
+ stat.refresh()
+
+ try:
+ while True:
+ # NOTE: getch() only handles ascii
+ # to handle wide char like: é, use get_wch()
+ ipt = Key(stat.get_wch())
+ # get_wch() return ambiguous type
+ # str for string input but int for function or special keys
+ # if type(ipt) == str:
+ # ipt = ord(ipt)
+
+ if ipt == Key(27):
+ stat.clear()
+ stat.refresh()
+ curses.echo(False)
+ safe_curs_set(0)
+ return NoUpdate()
+ elif ipt == Key(10):
+ stat.clear()
+ stat.refresh()
+ curses.echo(False)
+ safe_curs_set(0)
+ return init_text
+ elif ipt in (Key(8), Key(127), Key(curses.KEY_BACKSPACE)):
+ init_text = init_text[:-1]
+ elif ipt == Key(curses.KEY_RESIZE):
+ stat.clear()
+ stat.refresh()
+ curses.echo(False)
+ safe_curs_set(0)
+ return Key(curses.KEY_RESIZE)
+ # elif len(init_text) <= maxlen:
+ else:
+ init_text += ipt.char
+
+ stat.clear()
+ stat.addstr(0, 0, prompt, curses.A_REVERSE)
+ stat.addstr(
+ 0,
+ len(prompt),
+ init_text
+ if len(prompt + init_text) < cols
+ else "..." + init_text[len(prompt) - cols + 4 :],
+ )
+ stat.refresh()
+ except KeyboardInterrupt:
+ stat.clear()
+ stat.refresh()
+ curses.echo(False)
+ safe_curs_set(0)
+ return NoUpdate()
+
+ def searching(
+ self, board: InfiniBoard, src: Sequence[str], reading_state: ReadingState, tot
+ ) -> Union[NoUpdate, ReadingState, Key]:
+ # reusable loop indices
+ i: Any
+ j: Any
+
+ rows, cols = self.screen.getmaxyx()
+ # unnecessary
+ # if self.spread == 2:
+ # reading_state = dataclasses.replace(reading_state, textwidth=(cols - 7) // 2)
+
+ x = (cols - reading_state.textwidth) // 2
+ if self.spread == 1:
+ x = (cols - reading_state.textwidth) // 2
+ else:
+ x = 2
+
+ if not self.search_data:
+ candidate_text = self.input_prompt(" Regex:")
+ # if isinstance(candidate_text, str) and candidate_text != "":
+ if isinstance(candidate_text, str) and candidate_text:
+ self.search_data = SearchData(value=candidate_text)
+ else:
+ assert isinstance(candidate_text, NoUpdate) or isinstance(candidate_text, Key)
+ return candidate_text
+
+ found = []
+ try:
+ pattern = re.compile(self.search_data.value, re.IGNORECASE)
+ except re.error as reerrmsg:
+ self.search_data = None
+ tmpk = self.show_win_error("!Regex Error", str(reerrmsg), tuple())
+ return tmpk
+
+ for n, i in enumerate(src):
+ for j in pattern.finditer(i):
+ found.append([n, j.span()[0], j.span()[1] - j.span()[0]])
+
+ if not found:
+ if (
+ self.search_data.direction == Direction.FORWARD
+ and reading_state.content_index + 1 < tot
+ ):
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ elif (
+ self.search_data.direction == Direction.BACKWARD and reading_state.content_index > 0
+ ):
+ return ReadingState(
+ content_index=reading_state.content_index - 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ else:
+ s: Union[NoUpdate, Key] = NoUpdate()
+ while True:
+ if s in self.keymap.Quit:
+ self.search_data = None
+ self.screen.clear()
+ self.screen.refresh()
+ return reading_state
+ # TODO: maybe >= 0?
+ elif s == Key("n") and reading_state.content_index == 0:
+ self.search_data = dataclasses.replace(
+ self.search_data, direction=Direction.FORWARD
+ )
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ elif s == Key("N") and reading_state.content_index + 1 == tot:
+ self.search_data = dataclasses.replace(
+ self.search_data, direction=Direction.BACKWARD
+ )
+ return ReadingState(
+ content_index=reading_state.content_index - 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+
+ self.screen.clear()
+ self.screen.addstr(
+ rows - 1,
+ 0,
+ " Finished searching: " + self.search_data.value[: cols - 22] + " ",
+ curses.A_REVERSE,
+ )
+ board.write(reading_state.row, 1)
+ self.screen.refresh()
+ s = board.getch()
+
+ sidx = len(found) - 1
+ if self.search_data.direction == Direction.FORWARD:
+ if reading_state.row > found[-1][0]:
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ for n, i in enumerate(found):
+ if i[0] >= reading_state.row:
+ sidx = n
+ break
+
+ s = NoUpdate()
+ msg = (
+ " Searching: "
+ + self.search_data.value
+ + " --- Res {}/{} Ch {}/{} ".format(
+ sidx + 1, len(found), reading_state.content_index + 1, tot
+ )
+ )
+ while True:
+ if s in self.keymap.Quit:
+ self.search_data = None
+ # for i in found:
+ # pad.chgat(i[0], i[1], i[2], pad.getbkgd())
+ board.feed_temporary_style()
+ # pad.format()
+ # self.screen.clear()
+ # self.screen.refresh()
+ return reading_state
+ elif s == Key("n"):
+ self.search_data = dataclasses.replace(
+ self.search_data, direction=Direction.FORWARD
+ )
+ if sidx == len(found) - 1:
+ if reading_state.content_index + 1 < tot:
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ else:
+ s = NoUpdate()
+ msg = " Finished searching: " + self.search_data.value + " "
+ continue
+ else:
+ sidx += 1
+ msg = (
+ " Searching: "
+ + self.search_data.value
+ + " --- Res {}/{} Ch {}/{} ".format(
+ sidx + 1, len(found), reading_state.content_index + 1, tot
+ )
+ )
+ elif s == Key("N"):
+ self.search_data = dataclasses.replace(
+ self.search_data, direction=Direction.BACKWARD
+ )
+ if sidx == 0:
+ if reading_state.content_index > 0:
+ return ReadingState(
+ content_index=reading_state.content_index - 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+ else:
+ s = NoUpdate()
+ msg = " Finished searching: " + self.search_data.value + " "
+ continue
+ else:
+ sidx -= 1
+ msg = (
+ " Searching: "
+ + self.search_data.value
+ + " --- Res {}/{} Ch {}/{} ".format(
+ sidx + 1, len(found), reading_state.content_index + 1, tot
+ )
+ )
+ elif s == Key(curses.KEY_RESIZE):
+ return Key(curses.KEY_RESIZE)
+
+ # if reading_state.row + rows - 1 > pad.chunks[pad.find_chunkidx(reading_state.row)]:
+ # reading_state = dataclasses.replace(
+ # reading_state, row=pad.chunks[pad.find_chunkidx(reading_state.row)] + 1
+ # )
+
+ while found[sidx][0] not in list(
+ range(reading_state.row, reading_state.row + (rows - 1) * self.spread)
+ ):
+ if found[sidx][0] > reading_state.row:
+ reading_state = dataclasses.replace(
+ reading_state, row=reading_state.row + ((rows - 1) * self.spread)
+ )
+ else:
+ reading_state = dataclasses.replace(
+ reading_state, row=reading_state.row - ((rows - 1) * self.spread)
+ )
+ if reading_state.row < 0:
+ reading_state = dataclasses.replace(reading_state, row=0)
+
+ # formats = [InlineStyle(row=i[0], col=i[1], n_letters=i[2], attr=curses.A_REVERSE) for i in found]
+ # pad.feed_style(formats)
+ styles: List[InlineStyle] = []
+ for n, i in enumerate(found):
+ attr = curses.A_REVERSE if n == sidx else curses.A_NORMAL
+ # pad.chgat(i[0], i[1], i[2], pad.getbkgd() | attr)
+ styles.append(
+ InlineStyle(row=i[0], col=i[1], n_letters=i[2], attr=board.getbkgd() | attr)
+ )
+ board.feed_temporary_style(tuple(styles))
+
+ self.screen.clear()
+ self.screen.addstr(rows - 1, 0, msg, curses.A_REVERSE)
+ self.screen.refresh()
+ # pad.refresh(reading_state.row, 0, 0, x, rows - 2, x + reading_state.textwidth)
+ board.write(reading_state.row, 1)
+ s = board.getch()
+
+ def speaking(self, text):
+ self.is_speaking = True
+ self.screen.addstr(self.screen_rows - 1, 0, " Speaking! ", curses.A_REVERSE)
+ self.screen.refresh()
+ self.screen.timeout(1)
+ try:
+ self._tts_speaker.speak(text)
+
+ while True:
+ if self._tts_speaker.is_done():
+ k = self.keymap.PageDown[0]
+ break
+ tmp = self.screen.getch()
+ k = NoUpdate() if tmp == -1 else Key(tmp)
+ if k == Key(curses.KEY_MOUSE):
+ mouse_event = curses.getmouse()
+ if mouse_event[4] == curses.BUTTON2_CLICKED:
+ k = self.keymap.Quit[0]
+ elif mouse_event[4] == curses.BUTTON1_CLICKED:
+ if mouse_event[1] < self.screen_cols // 2:
+ k = self.keymap.PageUp[0]
+ else:
+ k = self.keymap.PageDown[0]
+ elif mouse_event[4] == curses.BUTTON4_PRESSED:
+ k = self.keymap.ScrollUp[0]
+ elif mouse_event[4] == 2097152:
+ k = self.keymap.ScrollDown[0]
+ if (
+ k
+ in self.keymap.Quit
+ + self.keymap.PageUp
+ + self.keymap.PageDown
+ + self.keymap.ScrollUp
+ + self.keymap.ScrollDown
+ + (curses.KEY_RESIZE,)
+ ):
+ self._tts_speaker.stop()
+ break
+ finally:
+ self.screen.timeout(-1)
+ self._tts_speaker.cleanup()
+
+ if k in self.keymap.Quit:
+ self.is_speaking = False
+ k = NoUpdate()
+ return k
+
+ def savestate(self, reading_state: ReadingState) -> None:
+ if self.seamless:
+ reading_state = self.convert_absolute_reading_state_to_relative(reading_state)
+ self.state.set_last_reading_state(self.ebook, reading_state)
+ self.state.update_library(self.ebook, self.reading_progress)
+
+ def cleanup(self) -> None:
+ self.ebook.cleanup()
+
+ if isinstance(self._process_counting_letter, multiprocessing.Process):
+ if self._process_counting_letter.is_alive():
+ self._process_counting_letter.terminate()
+ # weird python multiprocessing issue, need to call .join() before .close()
+ # ValueError: Cannot close a process while it is still running.
+ # You should first call join() or terminate().
+ self._process_counting_letter.join()
+ self._process_counting_letter.close()
+
+ def convert_absolute_reading_state_to_relative(self, reading_state) -> ReadingState:
+ if not self.seamless:
+ raise RuntimeError(
+ "Reader.convert_absolute_reading_state_to_relative() only implemented when Seamless=True"
+ )
+ return construct_relative_reading_state(reading_state, self.totlines_per_content)
+
+ def convert_relative_reading_state_to_absolute(
+ self, reading_state: ReadingState
+ ) -> ReadingState:
+ if not self.seamless:
+ raise RuntimeError(
+ "Reader.convert_relative_reading_state_to_absolute() only implemented when Seamless=True"
+ )
+
+ absolute_row = reading_state.row + sum(
+ self.totlines_per_content[: reading_state.content_index]
+ )
+ absolute_pctg = (
+ absolute_row / sum(self.totlines_per_content) if reading_state.rel_pctg else None
+ )
+
+ return dataclasses.replace(
+ reading_state, content_index=0, row=absolute_row, rel_pctg=absolute_pctg
+ )
+
+ def get_all_book_contents(
+ self, reading_state: ReadingState
+ ) -> Tuple[TextStructure, Tuple[TocEntry, ...], Union[Tuple[str, ...], Tuple[ET.Element, ...]]]:
+ if not self.seamless:
+ raise RuntimeError("Reader.get_all_book_contents() only implemented when Seamless=True")
+
+ contents = self.ebook.contents
+ toc_entries = self.ebook.toc_entries
+
+ text_structure: TextStructure = TextStructure(
+ text_lines=tuple(), image_maps=dict(), section_rows=dict(), formatting=tuple()
+ )
+ toc_entries_tmp: List[TocEntry] = []
+ section_rows_tmp: Dict[str, int] = dict()
+
+ # self.totlines_per_content only defined when Seamless=True
+ self.totlines_per_content: Tuple[int, ...] = tuple()
+
+ for n, content in enumerate(contents):
+ self.show_loader(subtext=f"loading contents ({n+1}/{len(contents)})")
+ starting_line = sum(self.totlines_per_content)
+ assert isinstance(content, str) or isinstance(content, ET.Element)
+ text_structure_tmp = parse_html(
+ self.ebook.get_raw_text(content),
+ textwidth=reading_state.textwidth,
+ section_ids=set(toc_entry.section for toc_entry in toc_entries), # type: ignore
+ starting_line=starting_line,
+ )
+ assert isinstance(text_structure_tmp, TextStructure)
+ # self.totlines_per_content.append(len(text_structure_tmp.text_lines))
+ self.totlines_per_content += (len(text_structure_tmp.text_lines),)
+
+ for toc_entry in toc_entries:
+ if toc_entry.content_index == n:
+ if toc_entry.section:
+ toc_entries_tmp.append(dataclasses.replace(toc_entry, content_index=0))
+ else:
+ section_id_tmp = str(uuid.uuid4())
+ toc_entries_tmp.append(
+ TocEntry(label=toc_entry.label, content_index=0, section=section_id_tmp)
+ )
+ section_rows_tmp[section_id_tmp] = starting_line
+
+ text_structure = merge_text_structures(text_structure, text_structure_tmp)
+
+ text_structure = dataclasses.replace(
+ text_structure, section_rows={**text_structure.section_rows, **section_rows_tmp}
+ )
+
+ return text_structure, tuple(toc_entries_tmp), (self.ebook.contents[0],)
+
+ def get_current_book_content(
+ self, reading_state: ReadingState
+ ) -> Tuple[TextStructure, Tuple[TocEntry, ...], Union[Tuple[str, ...], Tuple[ET.Element, ...]]]:
+ contents = self.ebook.contents
+ toc_entries = self.ebook.toc_entries
+ content_path = contents[reading_state.content_index]
+ content = self.ebook.get_raw_text(content_path)
+ text_structure = parse_html( # type: ignore
+ content,
+ textwidth=reading_state.textwidth,
+ section_ids=set(toc_entry.section for toc_entry in toc_entries), # type: ignore
+ )
+ return text_structure, toc_entries, contents
+
+ def read(self, reading_state: ReadingState) -> Union[ReadingState, Ebook]:
+ # reusable loop indices
+ i: Any
+
+ k = self.keymap.RegexSearch[0] if self.search_data else NoUpdate()
+ rows, cols = self.screen.getmaxyx()
+
+ mincols_doublespr = (
+ DoubleSpreadPadding.LEFT.value
+ + 22
+ + DoubleSpreadPadding.MIDDLE.value
+ + 22
+ + DoubleSpreadPadding.RIGHT.value
+ )
+ if cols < mincols_doublespr:
+ self.spread = 1
+ if self.spread == 2:
+ reading_state = dataclasses.replace(
+ reading_state,
+ textwidth=(
+ cols
+ - sum(
+ [
+ DoubleSpreadPadding.LEFT.value,
+ DoubleSpreadPadding.MIDDLE.value,
+ DoubleSpreadPadding.RIGHT.value,
+ ]
+ )
+ )
+ // 2,
+ )
+ x = (cols - reading_state.textwidth) // 2
+ if self.spread == 2:
+ x = DoubleSpreadPadding.LEFT.value
+
+ self.show_loader(subtext="loading contents")
+ # get text structure, toc entries and contents of the book
+ if self.seamless:
+ text_structure, toc_entries, contents = self.get_all_book_contents(reading_state)
+ # adjustment
+ reading_state = self.convert_relative_reading_state_to_absolute(reading_state)
+ else:
+ text_structure, toc_entries, contents = self.get_current_book_content(reading_state)
+
+ totlines = len(text_structure.text_lines)
+
+ if reading_state.row < 0 and totlines <= rows * self.spread:
+ reading_state = dataclasses.replace(reading_state, row=0)
+ elif reading_state.rel_pctg is not None:
+ reading_state = dataclasses.replace(
+ reading_state, row=round(reading_state.rel_pctg * totlines)
+ )
+ else:
+ reading_state = dataclasses.replace(reading_state, row=reading_state.row % totlines)
+
+ board = InfiniBoard(
+ screen=self.screen,
+ text=text_structure.text_lines,
+ textwidth=reading_state.textwidth,
+ default_style=text_structure.formatting,
+ spread=self.spread,
+ )
+
+ letters_per_content: List[int] = []
+ for i in text_structure.text_lines:
+ letters_per_content.append(len(re.sub(r"\s", "", i)))
+
+ self.screen.clear()
+ self.screen.refresh()
+ # try-except clause if there is issue
+ # with curses resize event
+ board.write(reading_state.row)
+
+ # if reading_state.section is not None
+ # then override reading_state.row to follow the section
+ if reading_state.section:
+ reading_state = dataclasses.replace(
+ reading_state, row=text_structure.section_rows.get(reading_state.section, 0)
+ )
+
+ checkpoint_row: Optional[int] = None
+ countstring = ""
+
+ try:
+ while True:
+ if countstring == "":
+ count = 1
+ else:
+ count = int(countstring)
+ if k in tuple(Key(i) for i in range(48, 58)): # i.e., k is a numeral
+ countstring = countstring + k.char
+ else:
+ if k in self.keymap.Quit:
+ if k == Key(27) and countstring != "":
+ countstring = ""
+ else:
+ self.try_assign_letters_count(force_wait=True)
+ self.calculate_reading_progress(letters_per_content, reading_state)
+
+ self.savestate(
+ dataclasses.replace(
+ reading_state, rel_pctg=reading_state.row / totlines
+ )
+ )
+ sys.exit()
+
+ elif k in self.keymap.TTSToggle and self.tts_support:
+ tospeak = ""
+ for i in text_structure.text_lines[
+ reading_state.row : reading_state.row + (rows * self.spread)
+ ]:
+ if re.match(r"^\s*$", i) is not None:
+ tospeak += "\n. \n"
+ else:
+ tospeak += i + " "
+ k = self.speaking(tospeak)
+ if (
+ totlines - reading_state.row <= rows
+ and reading_state.content_index == len(contents) - 1
+ ):
+ self.is_speaking = False
+ continue
+
+ elif k in self.keymap.DoubleSpreadToggle:
+ if cols < mincols_doublespr:
+ k = self.show_win_error(
+ "Screen is too small",
+ "Min: {} cols x {} rows".format(mincols_doublespr, 12),
+ (Key("D"),),
+ )
+ self.spread = (self.spread % 2) + 1
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=reading_state.textwidth,
+ row=reading_state.row,
+ rel_pctg=reading_state.row / totlines,
+ )
+
+ elif k in self.keymap.ScrollUp:
+ if self.spread == 2:
+ k = self.keymap.PageUp[0]
+ continue
+ if count > 1:
+ checkpoint_row = reading_state.row - 1
+ if reading_state.row >= count:
+ reading_state = dataclasses.replace(
+ reading_state, row=reading_state.row - count
+ )
+ elif reading_state.row == 0 and reading_state.content_index != 0:
+ self.page_animation = Direction.BACKWARD
+ # return -1, width, -rows, None, ""
+ return ReadingState(
+ content_index=reading_state.content_index - 1,
+ textwidth=reading_state.textwidth,
+ row=-rows,
+ )
+ else:
+ reading_state = dataclasses.replace(reading_state, row=0)
+
+ elif k in self.keymap.PageUp:
+ if reading_state.row == 0 and reading_state.content_index != 0:
+ self.page_animation = Direction.BACKWARD
+ text_structure_content_before = parse_html(
+ self.ebook.get_raw_text(contents[reading_state.content_index - 1]),
+ textwidth=reading_state.textwidth,
+ )
+ assert isinstance(text_structure_content_before, TextStructure)
+ return ReadingState(
+ content_index=reading_state.content_index - 1,
+ textwidth=reading_state.textwidth,
+ row=rows
+ * self.spread
+ * (
+ len(text_structure_content_before.text_lines)
+ // (rows * self.spread)
+ ),
+ )
+ else:
+ if reading_state.row >= rows * self.spread * count:
+ self.page_animation = Direction.BACKWARD
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=reading_state.row - (rows * self.spread * count),
+ )
+ else:
+ reading_state = dataclasses.replace(reading_state, row=0)
+
+ elif k in self.keymap.ScrollDown:
+ if self.spread == 2:
+ k = self.keymap.PageDown[0]
+ continue
+ if count > 1:
+ checkpoint_row = reading_state.row + rows - 1
+ if reading_state.row + count <= totlines - rows:
+ reading_state = dataclasses.replace(
+ reading_state, row=reading_state.row + count
+ )
+ elif (
+ reading_state.row >= totlines - rows
+ and reading_state.content_index != len(contents) - 1
+ ):
+ self.page_animation = Direction.FORWARD
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+
+ elif k in self.keymap.PageDown:
+ if totlines - reading_state.row > rows * self.spread:
+ self.page_animation = Direction.FORWARD
+ reading_state = dataclasses.replace(
+ reading_state, row=reading_state.row + (rows * self.spread)
+ )
+ elif reading_state.content_index != len(contents) - 1:
+ self.page_animation = Direction.FORWARD
+ return ReadingState(
+ content_index=reading_state.content_index + 1,
+ textwidth=reading_state.textwidth,
+ row=0,
+ )
+
+ # elif k in K["HalfScreenUp"] | K["HalfScreenDown"]:
+ # countstring = str(rows // 2)
+ # k = list(K["ScrollUp" if k in K["HalfScreenUp"] else "ScrollDown"])[0]
+ # continue
+
+ elif k in self.keymap.NextChapter:
+ ntoc = find_current_content_index(
+ toc_entries,
+ text_structure.section_rows,
+ reading_state.content_index,
+ reading_state.row,
+ )
+ if ntoc < len(toc_entries) - 1:
+ if reading_state.content_index == toc_entries[ntoc + 1].content_index:
+ try:
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows[
+ toc_entries[ntoc + 1].section # type: ignore
+ ],
+ )
+ except KeyError:
+ pass
+ else:
+ return ReadingState(
+ content_index=toc_entries[ntoc + 1].content_index,
+ textwidth=reading_state.textwidth,
+ row=0,
+ section=toc_entries[ntoc + 1].section,
+ )
+
+ elif k in self.keymap.PrevChapter:
+ ntoc = find_current_content_index(
+ toc_entries,
+ text_structure.section_rows,
+ reading_state.content_index,
+ reading_state.row,
+ )
+ if ntoc > 0:
+ if reading_state.content_index == toc_entries[ntoc - 1].content_index:
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows.get(
+ toc_entries[ntoc - 1].section, 0 # type: ignore
+ ),
+ )
+ else:
+ return ReadingState(
+ content_index=toc_entries[ntoc - 1].content_index,
+ textwidth=reading_state.textwidth,
+ row=0,
+ section=toc_entries[ntoc - 1].section,
+ )
+
+ elif k in self.keymap.BeginningOfCh:
+ ntoc = find_current_content_index(
+ toc_entries,
+ text_structure.section_rows,
+ reading_state.content_index,
+ reading_state.row,
+ )
+ try:
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows[toc_entries[ntoc].section], # type: ignore
+ )
+ except (KeyError, IndexError):
+ reading_state = dataclasses.replace(reading_state, row=0)
+
+ elif k in self.keymap.EndOfCh:
+ ntoc = find_current_content_index(
+ toc_entries,
+ text_structure.section_rows,
+ reading_state.content_index,
+ reading_state.row,
+ )
+ try:
+ if (
+ text_structure.section_rows[toc_entries[ntoc + 1].section] - rows # type: ignore
+ >= 0
+ ):
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows[toc_entries[ntoc + 1].section] # type: ignore
+ - rows,
+ )
+ else:
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows[toc_entries[ntoc].section], # type: ignore
+ )
+ except (KeyError, IndexError):
+ reading_state = dataclasses.replace(
+ reading_state, row=pgend(totlines, rows)
+ )
+
+ elif k in self.keymap.TableOfContents:
+ if not toc_entries:
+ k = self.show_win_error(
+ "Table of Contents",
+ "N/A: TableOfContents is unavailable for this book.",
+ self.keymap.TableOfContents,
+ )
+ continue
+ ntoc = find_current_content_index(
+ toc_entries,
+ text_structure.section_rows,
+ reading_state.content_index,
+ reading_state.row,
+ )
+ rettock, fllwd, _ = self.toc(toc_entries, ntoc)
+ if rettock is not None: # and rettock in WINKEYS:
+ k = rettock
+ continue
+ elif fllwd is not None:
+ if reading_state.content_index == toc_entries[fllwd].content_index:
+ try:
+ reading_state = dataclasses.replace(
+ reading_state,
+ row=text_structure.section_rows[toc_entries[fllwd].section],
+ )
+ except KeyError:
+ reading_state = dataclasses.replace(reading_state, row=0)
+ else:
+ return ReadingState(
+ content_index=toc_entries[fllwd].content_index,
+ textwidth=reading_state.textwidth,
+ row=0,
+ section=toc_entries[fllwd].section,
+ )
+
+ elif k in self.keymap.Metadata:
+ k = self.show_win_metadata()
+ if k in self._win_keys:
+ continue
+
+ elif k in self.keymap.Help:
+ k = self.show_win_help()
+ if k in self._win_keys:
+ continue
+
+ elif (
+ k in self.keymap.Enlarge
+ and (reading_state.textwidth + count) < cols - 4
+ and self.spread == 1
+ ):
+ return dataclasses.replace(
+ reading_state,
+ textwidth=reading_state.textwidth + count,
+ rel_pctg=reading_state.row / totlines,
+ )
+
+ elif (
+ k in self.keymap.Shrink
+ and reading_state.textwidth >= 22
+ and self.spread == 1
+ ):
+ return dataclasses.replace(
+ reading_state,
+ textwidth=reading_state.textwidth - count,
+ rel_pctg=reading_state.row / totlines,
+ )
+
+ elif k in self.keymap.SetWidth and self.spread == 1:
+ if countstring == "":
+ # if called without a count, toggle between 80 cols and full width
+ if reading_state.textwidth != 80 and cols - 4 >= 80:
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=80,
+ row=reading_state.row,
+ rel_pctg=reading_state.row / totlines,
+ )
+ else:
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=cols - 4,
+ row=reading_state.row,
+ rel_pctg=reading_state.row / totlines,
+ )
+ else:
+ reading_state = dataclasses.replace(reading_state, textwidth=count)
+ if reading_state.textwidth < 20:
+ reading_state = dataclasses.replace(reading_state, textwidth=20)
+ elif reading_state.textwidth >= cols - 4:
+ reading_state = dataclasses.replace(reading_state, textwidth=cols - 4)
+
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=reading_state.textwidth,
+ row=reading_state.row,
+ rel_pctg=reading_state.row / totlines,
+ )
+
+ elif k in self.keymap.RegexSearch:
+ ret_object = self.searching(
+ board,
+ text_structure.text_lines,
+ reading_state,
+ len(contents),
+ )
+ if isinstance(ret_object, Key) or isinstance(ret_object, NoUpdate):
+ k = ret_object
+ # k = ret_object.value
+ continue
+ elif isinstance(ret_object, ReadingState) and self.search_data:
+ return ret_object
+ # else:
+ elif isinstance(ret_object, ReadingState):
+ # y = ret_object
+ reading_state = ret_object
+
+ elif k in self.keymap.OpenImage and self.image_viewer:
+ imgs_in_screen = list(
+ set(
+ range(reading_state.row, reading_state.row + rows * self.spread + 1)
+ )
+ & set(text_structure.image_maps.keys())
+ )
+ if not imgs_in_screen:
+ k = NoUpdate()
+ continue
+
+ imgs_in_screen.sort()
+ image_path: Optional[str] = None
+ if len(imgs_in_screen) == 1:
+ image_path = text_structure.image_maps[imgs_in_screen[0]]
+ elif len(imgs_in_screen) > 1:
+ imgs_rel_to_row = [i - reading_state.row for i in imgs_in_screen]
+ p: Union[NoUpdate, Key] = NoUpdate()
+ i = 0
+ while p not in self.keymap.Quit and p not in self.keymap.Follow:
+ self.screen.move(
+ imgs_rel_to_row[i] % rows,
+ (
+ x
+ if imgs_rel_to_row[i] // rows == 0
+ else cols
+ - DoubleSpreadPadding.RIGHT.value
+ - reading_state.textwidth
+ )
+ + reading_state.textwidth // 2,
+ )
+ self.screen.refresh()
+ safe_curs_set(2)
+ p = board.getch()
+ if p in self.keymap.ScrollDown:
+ i += 1
+ elif p in self.keymap.ScrollUp:
+ i -= 1
+ i = i % len(imgs_rel_to_row)
+
+ safe_curs_set(0)
+ if p in self.keymap.Follow:
+ image_path = text_structure.image_maps[imgs_in_screen[i]]
+
+ if image_path:
+ try:
+ # if self.ebook.__class__.__name__ in {"Epub", "Mobi", "Azw"}:
+ if isinstance(self.ebook, (Epub, Mobi, Azw)):
+ # self.seamless adjustment
+ if self.seamless:
+ current_content_index = (
+ self.convert_absolute_reading_state_to_relative(
+ reading_state
+ ).content_index
+ )
+ else:
+ current_content_index = reading_state.content_index
+ # for n, content in enumerate(self.ebook.contents):
+ # content_path = content
+ # if reading_state.row < sum(totlines_per_content[:n]):
+ # break
+
+ content_path = self.ebook.contents[current_content_index]
+ assert isinstance(content_path, str)
+ image_path = resolve_path(content_path, image_path)
+ imgnm, imgbstr = self.ebook.get_img_bytestr(image_path)
+ k = self.open_image(board, imgnm, imgbstr)
+ continue
+ except Exception as e:
+ self.show_win_error("Error Opening Image", str(e), tuple())
+ if DEBUG:
+ raise e
+
+ elif (
+ k in self.keymap.SwitchColor
+ and self.is_color_supported
+ and countstring in {"", "0", "1", "2"}
+ ):
+ if countstring == "":
+ count_color = curses.pair_number(self.screen.getbkgd())
+ if count_color not in {2, 3}:
+ count_color = 1
+ count_color = count_color % 3
+ else:
+ count_color = count
+ self.screen.bkgd(curses.color_pair(count_color + 1))
+ # pad.format()
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=reading_state.textwidth,
+ row=reading_state.row,
+ )
+
+ elif k in self.keymap.AddBookmark:
+ bmname = self.input_prompt(" Add bookmark:")
+ if isinstance(bmname, str) and bmname:
+ try:
+ self.state.insert_bookmark(
+ self.ebook,
+ bmname,
+ dataclasses.replace(
+ reading_state, rel_pctg=reading_state.row / totlines
+ ),
+ )
+ except sqlite3.IntegrityError:
+ k = self.show_win_error(
+ "Error: Add Bookmarks",
+ f"Bookmark with name '{bmname}' already exists.",
+ (Key("B"),),
+ )
+ continue
+ else:
+ k = bmname
+ continue
+
+ elif k in self.keymap.ShowBookmarks:
+ bookmarks = self.state.get_bookmarks(self.ebook)
+ if not bookmarks:
+ k = self.show_win_error(
+ "Bookmarks",
+ "N/A: Bookmarks are not found in this book.",
+ self.keymap.ShowBookmarks,
+ )
+ continue
+ else:
+ retk, idxchoice = self.show_win_choices_bookmarks()
+ if retk is not None:
+ k = retk
+ continue
+ elif idxchoice is not None:
+ bookmark_to_jump = self.state.get_bookmarks(self.ebook)[idxchoice][
+ 1
+ ]
+ if (
+ bookmark_to_jump.content_index == reading_state.content_index
+ and bookmark_to_jump.textwidth == reading_state.textwidth
+ ):
+ reading_state = bookmark_to_jump
+ else:
+ return ReadingState(
+ content_index=bookmark_to_jump.content_index,
+ textwidth=reading_state.textwidth,
+ row=bookmark_to_jump.row,
+ rel_pctg=bookmark_to_jump.rel_pctg,
+ )
+
+ elif k in self.keymap.DefineWord and self.ext_dict_app:
+ word = self.input_prompt(" Define:")
+ if isinstance(word, str) and word:
+ defin = self.define_word(word)
+ if defin in self._win_keys:
+ k = defin
+ continue
+ else:
+ k = word
+ continue
+
+ elif k in self.keymap.MarkPosition:
+ jumnum = board.getch()
+ if isinstance(jumnum, Key) and jumnum in tuple(
+ Key(i) for i in range(48, 58)
+ ):
+ self.jump_list[jumnum.char] = reading_state
+ else:
+ k = NoUpdate()
+ continue
+
+ elif k in self.keymap.JumpToPosition:
+ jumnum = board.getch()
+ if (
+ isinstance(jumnum, Key)
+ and jumnum in tuple(Key(i) for i in range(48, 58))
+ and jumnum.char in self.jump_list
+ ):
+ marked_reading_state = self.jump_list[jumnum.char]
+ return dataclasses.replace(
+ marked_reading_state,
+ textwidth=reading_state.textwidth,
+ rel_pctg=None
+ if marked_reading_state.textwidth == reading_state.textwidth
+ else marked_reading_state.rel_pctg,
+ section="",
+ )
+ else:
+ k = NoUpdate()
+ continue
+
+ elif k in self.keymap.ShowHideProgress:
+ self.show_reading_progress = not self.show_reading_progress
+
+ elif k in self.keymap.Library:
+ self.try_assign_letters_count(force_wait=True)
+ self.calculate_reading_progress(letters_per_content, reading_state)
+
+ self.savestate(
+ dataclasses.replace(
+ reading_state, rel_pctg=reading_state.row / totlines
+ )
+ )
+ library_items = self.state.get_from_history()
+ if not library_items:
+ k = self.show_win_error(
+ "Library",
+ "N/A: No reading history.",
+ self.keymap.Library,
+ )
+ continue
+ else:
+ retk, choice_index = self.show_win_library()
+ if retk is not None:
+ k = retk
+ continue
+ elif choice_index is not None:
+ return get_ebook_obj(library_items[choice_index].filepath)
+
+ elif k == Key(curses.KEY_RESIZE):
+ self.savestate(
+ dataclasses.replace(
+ reading_state, rel_pctg=reading_state.row / totlines
+ )
+ )
+ # stated in pypi windows-curses page:
+ # to call resize_term right after KEY_RESIZE
+ if sys.platform == "win32":
+ curses.resize_term(rows, cols)
+ rows, cols = self.screen.getmaxyx()
+ else:
+ rows, cols = self.screen.getmaxyx()
+ curses.resize_term(rows, cols)
+ if cols < 22 or rows < 12:
+ sys.exit("ERROR: Screen was too small (min 22cols x 12rows).")
+ if cols <= reading_state.textwidth + 4:
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=cols - 4,
+ row=reading_state.row,
+ rel_pctg=reading_state.row / totlines,
+ )
+ else:
+ return ReadingState(
+ content_index=reading_state.content_index,
+ textwidth=reading_state.textwidth,
+ row=reading_state.row,
+ )
+
+ countstring = ""
+
+ if checkpoint_row:
+ board.feed_temporary_style(
+ (
+ InlineStyle(
+ row=checkpoint_row,
+ col=0,
+ n_letters=reading_state.textwidth,
+ attr=curses.A_UNDERLINE,
+ ),
+ )
+ )
+
+ try:
+ if self.setting.PageScrollAnimation and self.page_animation:
+ self.screen.clear()
+ for i in range(1, reading_state.textwidth + 1):
+ curses.napms(1)
+ # self.screen.clear()
+ board.write_n(reading_state.row, i, self.page_animation)
+ self.screen.refresh()
+ self.page_animation = None
+
+ self.screen.clear()
+ self.screen.addstr(0, 0, countstring)
+ board.write(reading_state.row)
+
+ # check if letters counting process is done
+ self.try_assign_letters_count()
+
+ # reading progress
+ self.calculate_reading_progress(letters_per_content, reading_state)
+
+ # display reading progress
+ if (
+ self.reading_progress
+ and self.show_reading_progress
+ and (cols - reading_state.textwidth - 2) // 2 > 3
+ ):
+ reading_progress_str = "{}%".format(int(self.reading_progress * 100))
+ self.screen.addstr(
+ 0, cols - len(reading_progress_str), reading_progress_str
+ )
+
+ self.screen.refresh()
+ except curses.error:
+ pass
+
+ if self.is_speaking:
+ k = self.keymap.TTSToggle[0]
+ continue
+
+ k = board.getch()
+ if k == Key(curses.KEY_MOUSE):
+ mouse_event = curses.getmouse()
+ if mouse_event[4] == curses.BUTTON1_CLICKED:
+ if mouse_event[1] < cols // 2:
+ k = self.keymap.PageUp[0]
+ else:
+ k = self.keymap.PageDown[0]
+ elif mouse_event[4] == curses.BUTTON3_CLICKED:
+ k = self.keymap.TableOfContents[0]
+ elif mouse_event[4] == curses.BUTTON4_PRESSED:
+ k = self.keymap.ScrollUp[0]
+ elif mouse_event[4] == 2097152:
+ k = self.keymap.ScrollDown[0]
+ elif mouse_event[4] == curses.BUTTON4_PRESSED + curses.BUTTON_CTRL:
+ k = self.keymap.Enlarge[0]
+ elif mouse_event[4] == 2097152 + curses.BUTTON_CTRL:
+ k = self.keymap.Shrink[0]
+ elif mouse_event[4] == curses.BUTTON2_CLICKED:
+ k = self.keymap.TTSToggle[0]
+
+ if checkpoint_row:
+ board.feed_temporary_style()
+ checkpoint_row = None
+
+ except KeyboardInterrupt:
+ self.savestate(
+ dataclasses.replace(reading_state, rel_pctg=reading_state.row / totlines)
+ )
+ sys.exit()
+
+
+def start_reading(stdscr, filepath: str):
+
+ ebook = get_ebook_obj(filepath)
+ state = State()
+ config = Config()
+
+ reader = Reader(screen=stdscr, ebook=ebook, config=config, state=state)
+
+ def handle_signal(signum, _):
+ """
+ Method to raise SystemExit based on signal received
+ to trigger `try-finally` clause
+ """
+ msg = f"[{os.getpid()}] killed"
+ if signal.Signals(signum) == signal.SIGTERM:
+ msg = f"[{os.getpid()}] terminated"
+ sys.exit(msg)
+
+ signal.signal(signal.SIGTERM, handle_signal)
+
+ try:
+ reader.run_counting_letters()
+
+ reading_state = state.get_last_reading_state(reader.ebook)
+ if reader.screen_cols <= reading_state.textwidth + 4:
+ reading_state = dataclasses.replace(reading_state, textwidth=reader.screen_cols - 4)
+ else:
+ reading_state = dataclasses.replace(reading_state, rel_pctg=None)
+
+ while True:
+ reading_state_or_ebook = reader.read(reading_state)
+
+ if isinstance(reading_state_or_ebook, Ebook):
+ return reading_state_or_ebook.path
+ else:
+ reading_state = reading_state_or_ebook
+ if reader.seamless:
+ reading_state = reader.convert_absolute_reading_state_to_relative(reading_state)
+
+ finally:
+ reader.cleanup()
diff --git a/src/epy_reader/settings.py b/src/epy_reader/settings.py
new file mode 100644
index 0000000..f09bc98
--- /dev/null
+++ b/src/epy_reader/settings.py
@@ -0,0 +1,133 @@
+import curses
+from dataclasses import dataclass, field
+from enum import Enum
+from typing import List, Optional, Tuple
+
+from epy_reader.models import Key
+
+
+class DoubleSpreadPadding(Enum):
+ LEFT = 10
+ MIDDLE = 7
+ RIGHT = 10
+
+
+# add image viewers here
+# sorted by most widely used
+VIEWER_PRESET_LIST = (
+ "feh",
+ "imv",
+ "gio",
+ "gnome-open",
+ "gvfs-open",
+ "xdg-open",
+ "kde-open",
+ "firefox",
+)
+
+DICT_PRESET_LIST = (
+ "wkdict",
+ "sdcv",
+ "dict",
+)
+
+
+@dataclass(frozen=True)
+class Settings:
+ DefaultViewer: str = "auto"
+ DictionaryClient: str = "auto"
+ ShowProgressIndicator: bool = True
+ PageScrollAnimation: bool = True
+ MouseSupport: bool = False
+ StartWithDoubleSpread: bool = False
+ # -1 is default terminal fg/bg colors
+ DefaultColorFG: int = -1
+ DefaultColorBG: int = -1
+ DarkColorFG: int = 252
+ DarkColorBG: int = 235
+ LightColorFG: int = 238
+ LightColorBG: int = 253
+ SeamlessBetweenChapters: bool = False
+ PreferredTTSEngine: Optional[str] = None
+ TTSEngineArgs: List[str] = field(default_factory=list)
+
+
+@dataclass(frozen=True)
+class CfgDefaultKeymaps:
+ ScrollUp: str = "k"
+ ScrollDown: str = "j"
+ PageUp: str = "h"
+ PageDown: str = "l"
+ # HalfScreenUp: str = "h"
+ # HalfScreenDown: str
+ NextChapter: str = "L"
+ PrevChapter: str = "H"
+ BeginningOfCh: str = "g"
+ EndOfCh: str = "G"
+ Shrink: str = "-"
+ Enlarge: str = "+"
+ SetWidth: str = "="
+ Metadata: str = "M"
+ DefineWord: str = "d"
+ TableOfContents: str = "t"
+ Follow: str = "f"
+ OpenImage: str = "o"
+ RegexSearch: str = "/"
+ ShowHideProgress: str = "s"
+ MarkPosition: str = "m"
+ JumpToPosition: str = "`"
+ AddBookmark: str = "b"
+ ShowBookmarks: str = "B"
+ Quit: str = "q"
+ Help: str = "?"
+ SwitchColor: str = "c"
+ TTSToggle: str = "!"
+ DoubleSpreadToggle: str = "D"
+ Library: str = "R"
+
+
+@dataclass(frozen=True)
+class CfgBuiltinKeymaps:
+ ScrollUp: Tuple[int, ...] = (curses.KEY_UP,)
+ ScrollDown: Tuple[int, ...] = (curses.KEY_DOWN,)
+ PageUp: Tuple[int, ...] = (curses.KEY_PPAGE, curses.KEY_LEFT)
+ PageDown: Tuple[int, ...] = (curses.KEY_NPAGE, ord(" "), curses.KEY_RIGHT)
+ BeginningOfCh: Tuple[int, ...] = (curses.KEY_HOME,)
+ EndOfCh: Tuple[int, ...] = (curses.KEY_END,)
+ TableOfContents: Tuple[int, ...] = (9, ord("\t"))
+ Follow: Tuple[int, ...] = (10,)
+ Quit: Tuple[int, ...] = (3, 27, 304)
+
+
+@dataclass(frozen=True)
+class Keymap:
+ # HalfScreenDown: Tuple[Key, ...]
+ # HalfScreenUp: Tuple[Key, ...]
+ AddBookmark: Tuple[Key, ...]
+ BeginningOfCh: Tuple[Key, ...]
+ DefineWord: Tuple[Key, ...]
+ DoubleSpreadToggle: Tuple[Key, ...]
+ EndOfCh: Tuple[Key, ...]
+ Enlarge: Tuple[Key, ...]
+ Follow: Tuple[Key, ...]
+ Help: Tuple[Key, ...]
+ JumpToPosition: Tuple[Key, ...]
+ Library: Tuple[Key, ...]
+ MarkPosition: Tuple[Key, ...]
+ Metadata: Tuple[Key, ...]
+ NextChapter: Tuple[Key, ...]
+ OpenImage: Tuple[Key, ...]
+ PageDown: Tuple[Key, ...]
+ PageUp: Tuple[Key, ...]
+ PrevChapter: Tuple[Key, ...]
+ Quit: Tuple[Key, ...]
+ RegexSearch: Tuple[Key, ...]
+ ScrollDown: Tuple[Key, ...]
+ ScrollUp: Tuple[Key, ...]
+ SetWidth: Tuple[Key, ...]
+ ShowBookmarks: Tuple[Key, ...]
+ ShowHideProgress: Tuple[Key, ...]
+ Shrink: Tuple[Key, ...]
+ SwitchColor: Tuple[Key, ...]
+ TTSToggle: Tuple[Key, ...]
+ TableOfContents: Tuple[Key, ...]
diff --git a/src/epy_reader/speakers/__init__.py b/src/epy_reader/speakers/__init__.py
new file mode 100644
index 0000000..078be31
--- /dev/null
+++ b/src/epy_reader/speakers/__init__.py
@@ -0,0 +1,9 @@
+__all__ = [
+ "SpeakerBaseModel",
+ "SpeakerMimic",
+ "SpeakerPico",
+]
+
+from epy_reader.speakers.base import SpeakerBaseModel
+from epy_reader.speakers.mimic import SpeakerMimic
+from epy_reader.speakers.pico import SpeakerPico
diff --git a/src/epy_reader/speakers/base.py b/src/epy_reader/speakers/base.py
new file mode 100644
index 0000000..7c1a8d5
--- /dev/null
+++ b/src/epy_reader/speakers/base.py
@@ -0,0 +1,21 @@
+from typing import List
+
+
+class SpeakerBaseModel:
+ cmd: str = "tts_engine_binary"
+ available: bool = False
+
+ def __init__(self, args: List[str] = []):
+ self.args = args
+
+ def speak(self, text: str) -> None:
+ raise NotImplementedError("Speaker.speak() not implemented")
+
+ def is_done(self) -> bool:
+ raise NotImplementedError("Speaker.is_done() not implemented")
+
+ def stop(self) -> None:
+ raise NotImplementedError("Speaker.stop() not implemented")
+
+ def cleanup(self) -> None:
+ raise NotImplementedError("Speaker.cleanup() not implemented")
diff --git a/src/epy_reader/speakers/mimic.py b/src/epy_reader/speakers/mimic.py
new file mode 100644
index 0000000..0db4ed8
--- /dev/null
+++ b/src/epy_reader/speakers/mimic.py
@@ -0,0 +1,31 @@
+import shutil
+import subprocess
+
+from epy_reader.speakers.base import SpeakerBaseModel
+
+
+class SpeakerMimic(SpeakerBaseModel):
+ cmd = "mimic"
+ available = bool(shutil.which("mimic"))
+
+ def speak(self, text: str) -> None:
+ self.process = subprocess.Popen(
+ [self.cmd, *self.args],
+ text=True,
+ stdin=subprocess.PIPE,
+ stdout=subprocess.DEVNULL,
+ stderr=subprocess.STDOUT,
+ )
+ assert self.process.stdin
+ self.process.stdin.write(text)
+ self.process.stdin.close()
+
+ def is_done(self) -> bool:
+ return self.process.poll() is not None
+
+ def stop(self) -> None:
+ self.process.terminate()
+ # self.process.kill()
+
+ def cleanup(self) -> None:
+ pass
diff --git a/src/epy_reader/speakers/pico.py b/src/epy_reader/speakers/pico.py
new file mode 100644
index 0000000..95065f1
--- /dev/null
+++ b/src/epy_reader/speakers/pico.py
@@ -0,0 +1,43 @@
+import os
+import shutil
+import subprocess
+import sys
+import tempfile
+
+from epy_reader.speakers.base import SpeakerBaseModel
+
+
+class SpeakerPico(SpeakerBaseModel):
+ cmd = "pico2wave"
+ available = all([shutil.which(dep) for dep in ["pico2wave", "play"]])
+
+ def speak(self, text: str) -> None:
+ _, self.tmp_path = tempfile.mkstemp(suffix=".wav")
+
+ try:
+ subprocess.run(
+ [self.cmd, *self.args, "-w", self.tmp_path, text],
+ stdout=subprocess.PIPE,
+ stderr=subprocess.STDOUT,
+ text=True,
+ check=True,
+ )
+ except subprocess.CalledProcessError as e:
+ if "invalid pointer" not in e.output:
+ sys.exit(e.output)
+
+ self.process = subprocess.Popen(
+ ["play", self.tmp_path],
+ stdout=subprocess.DEVNULL,
+ stderr=subprocess.DEVNULL,
+ )
+
+ def is_done(self) -> bool:
+ return self.process.poll() is not None
+
+ def stop(self) -> None:
+ self.process.terminate()
+ # self.process.kill()
+
+ def cleanup(self) -> None:
+ os.remove(self.tmp_path)
diff --git a/src/epy_reader/state.py b/src/epy_reader/state.py
new file mode 100644
index 0000000..5129394
--- /dev/null
+++ b/src/epy_reader/state.py
@@ -0,0 +1,195 @@
+import dataclasses
+import hashlib
+import os
+import sqlite3
+from datetime import datetime
+from typing import List, Tuple
+
+from epy_reader.ebooks import Ebook
+from epy_reader.models import AppData, LibraryItem, Optional, ReadingState
+
+
+class State(AppData):
+ """
+ Use sqlite3 instead of JSON (in older version)
+ to shift the weight from memory to process
+ """
+
+ def __init__(self):
+ if not os.path.isfile(self.filepath):
+ self.init_db()
+
+ @property
+ def filepath(self) -> str:
+ return os.path.join(self.prefix, "states.db") if self.prefix else os.devnull
+
+ def get_from_history(self) -> List[LibraryItem]:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ cur = conn.cursor()
+ cur.execute(
+ """
+ SELECT last_read, filepath, title, author, reading_progress
+ FROM library ORDER BY last_read DESC
+ """
+ )
+ results = cur.fetchall()
+ library_items: List[LibraryItem] = []
+ for result in results:
+ library_items.append(
+ LibraryItem(
+ last_read=datetime.fromisoformat(result[0]),
+ filepath=result[1],
+ title=result[2],
+ author=result[3],
+ reading_progress=result[4],
+ )
+ )
+ return library_items
+ finally:
+ conn.close()
+
+ def delete_from_library(self, filepath: str) -> None:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.execute("PRAGMA foreign_keys = ON")
+ conn.execute("DELETE FROM reading_states WHERE filepath=?", (filepath,))
+ conn.commit()
+ finally:
+ conn.close()
+
+ def get_last_read(self) -> Optional[str]:
+ library = self.get_from_history()
+ return library[0].filepath if library else None
+
+ def update_library(self, ebook: Ebook, reading_progress: Optional[float]) -> None:
+ try:
+ metadata = ebook.get_meta()
+ conn = sqlite3.connect(self.filepath)
+ conn.execute(
+ """
+ INSERT OR REPLACE INTO library (filepath, title, author, reading_progress)
+ VALUES (?, ?, ?, ?)
+ """,
+ (ebook.path, metadata.title, metadata.creator, reading_progress),
+ )
+ conn.commit()
+ finally:
+ conn.close()
+
+ def get_last_reading_state(self, ebook: Ebook) -> ReadingState:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.row_factory = sqlite3.Row
+ cur = conn.cursor()
+ cur.execute("SELECT * FROM reading_states WHERE filepath=?", (ebook.path,))
+ result = cur.fetchone()
+ if result:
+ result = dict(result)
+ del result["filepath"]
+ return ReadingState(**result, section=None)
+ return ReadingState(content_index=0, textwidth=80, row=0, rel_pctg=None, section=None)
+ finally:
+ conn.close()
+
+ def set_last_reading_state(self, ebook: Ebook, reading_state: ReadingState) -> None:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.execute(
+ """
+ INSERT OR REPLACE INTO reading_states
+ VALUES (:filepath, :content_index, :textwidth, :row, :rel_pctg)
+ """,
+ {"filepath": ebook.path, **dataclasses.asdict(reading_state)},
+ )
+ conn.commit()
+ finally:
+ conn.close()
+
+ def insert_bookmark(self, ebook: Ebook, name: str, reading_state: ReadingState) -> None:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.execute(
+ """
+ INSERT INTO bookmarks
+ VALUES (:id, :filepath, :name, :content_index, :textwidth, :row, :rel_pctg)
+ """,
+ {
+ "id": hashlib.sha1(f"{ebook.path}{name}".encode()).hexdigest()[:10],
+ "filepath": ebook.path,
+ "name": name,
+ **dataclasses.asdict(reading_state),
+ },
+ )
+ conn.commit()
+ finally:
+ conn.close()
+
+ def delete_bookmark(self, ebook: Ebook, name: str) -> None:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.execute("DELETE FROM bookmarks WHERE filepath=? AND name=?", (ebook.path, name))
+ conn.commit()
+ finally:
+ conn.close()
+
+ def get_bookmarks(self, ebook: Ebook) -> List[Tuple[str, ReadingState]]:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.row_factory = sqlite3.Row
+ cur = conn.cursor()
+ cur.execute("SELECT * FROM bookmarks WHERE filepath=?", (ebook.path,))
+ results = cur.fetchall()
+ bookmarks: List[Tuple[str, ReadingState]] = []
+ for result in results:
+ tmp_dict = dict(result)
+ name = tmp_dict["name"]
+ tmp_dict = {
+ k: v
+ for k, v in tmp_dict.items()
+ if k in ("content_index", "textwidth", "row", "rel_pctg")
+ }
+ bookmarks.append((name, ReadingState(**tmp_dict)))
+ return bookmarks
+ finally:
+ conn.close()
+
+ def init_db(self) -> None:
+ try:
+ conn = sqlite3.connect(self.filepath)
+ conn.executescript(
+ """
+ CREATE TABLE reading_states (
+ filepath TEXT PRIMARY KEY,
+ content_index INTEGER,
+ textwidth INTEGER,
+ row INTEGER,
+ rel_pctg REAL
+ );
+
+ CREATE TABLE library (
+ last_read DATETIME DEFAULT (datetime('now','localtime')),
+ filepath TEXT PRIMARY KEY,
+ title TEXT,
+ author TEXT,
+ reading_progress REAL,
+ FOREIGN KEY (filepath) REFERENCES reading_states(filepath)
+ ON DELETE CASCADE
+ );
+
+ CREATE TABLE bookmarks (
+ id TEXT PRIMARY KEY,
+ filepath TEXT,
+ name TEXT,
+ content_index INTEGER,
+ textwidth INTEGER,
+ row INTEGER,
+ rel_pctg REAL,
+ FOREIGN KEY (filepath) REFERENCES reading_states(filepath)
+ ON DELETE CASCADE
+ );
+ """
+ )
+ conn.commit()
+ finally:
+ conn.close()
diff --git a/epy_extras/KindleUnpack/__init__.py b/src/epy_reader/tools/KindleUnpack/__init__.py
index 0077258..0077258 100644
--- a/epy_extras/KindleUnpack/__init__.py
+++ b/src/epy_reader/tools/KindleUnpack/__init__.py
diff --git a/epy_extras/KindleUnpack/compatibility_utils.py b/src/epy_reader/tools/KindleUnpack/compatibility_utils.py
index c46c0bb..c46c0bb 100755
--- a/epy_extras/KindleUnpack/compatibility_utils.py
+++ b/src/epy_reader/tools/KindleUnpack/compatibility_utils.py
diff --git a/epy_extras/KindleUnpack/kindleunpack.py b/src/epy_reader/tools/KindleUnpack/kindleunpack.py
index 317941a..317941a 100644
--- a/epy_extras/KindleUnpack/kindleunpack.py
+++ b/src/epy_reader/tools/KindleUnpack/kindleunpack.py
diff --git a/epy_extras/KindleUnpack/mobi_cover.py b/src/epy_reader/tools/KindleUnpack/mobi_cover.py
index 3078ac4..3078ac4 100644
--- a/epy_extras/KindleUnpack/mobi_cover.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_cover.py
diff --git a/epy_extras/KindleUnpack/mobi_dict.py b/src/epy_reader/tools/KindleUnpack/mobi_dict.py
index bfc2ea8..bfc2ea8 100644
--- a/epy_extras/KindleUnpack/mobi_dict.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_dict.py
diff --git a/epy_extras/KindleUnpack/mobi_header.py b/src/epy_reader/tools/KindleUnpack/mobi_header.py
index a15f636..a15f636 100644
--- a/epy_extras/KindleUnpack/mobi_header.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_header.py
diff --git a/epy_extras/KindleUnpack/mobi_html.py b/src/epy_reader/tools/KindleUnpack/mobi_html.py
index eda766c..eda766c 100644
--- a/epy_extras/KindleUnpack/mobi_html.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_html.py
diff --git a/epy_extras/KindleUnpack/mobi_index.py b/src/epy_reader/tools/KindleUnpack/mobi_index.py
index 397aaf8..397aaf8 100644
--- a/epy_extras/KindleUnpack/mobi_index.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_index.py
diff --git a/epy_extras/KindleUnpack/mobi_k8proc.py b/src/epy_reader/tools/KindleUnpack/mobi_k8proc.py
index 5b8274e..5b8274e 100644
--- a/epy_extras/KindleUnpack/mobi_k8proc.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_k8proc.py
diff --git a/epy_extras/KindleUnpack/mobi_k8resc.py b/src/epy_reader/tools/KindleUnpack/mobi_k8resc.py
index 1e58e84..1e58e84 100644
--- a/epy_extras/KindleUnpack/mobi_k8resc.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_k8resc.py
diff --git a/epy_extras/KindleUnpack/mobi_nav.py b/src/epy_reader/tools/KindleUnpack/mobi_nav.py
index 16fb0be..16fb0be 100644
--- a/epy_extras/KindleUnpack/mobi_nav.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_nav.py
diff --git a/epy_extras/KindleUnpack/mobi_ncx.py b/src/epy_reader/tools/KindleUnpack/mobi_ncx.py
index 60ef9a0..60ef9a0 100644
--- a/epy_extras/KindleUnpack/mobi_ncx.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_ncx.py
diff --git a/epy_extras/KindleUnpack/mobi_opf.py b/src/epy_reader/tools/KindleUnpack/mobi_opf.py
index 742d776..742d776 100644
--- a/epy_extras/KindleUnpack/mobi_opf.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_opf.py
diff --git a/epy_extras/KindleUnpack/mobi_pagemap.py b/src/epy_reader/tools/KindleUnpack/mobi_pagemap.py
index 5228d4e..5228d4e 100644
--- a/epy_extras/KindleUnpack/mobi_pagemap.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_pagemap.py
diff --git a/epy_extras/KindleUnpack/mobi_sectioner.py b/src/epy_reader/tools/KindleUnpack/mobi_sectioner.py
index 81f62bb..81f62bb 100644
--- a/epy_extras/KindleUnpack/mobi_sectioner.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_sectioner.py
diff --git a/epy_extras/KindleUnpack/mobi_split.py b/src/epy_reader/tools/KindleUnpack/mobi_split.py
index 3535029..3535029 100755
--- a/epy_extras/KindleUnpack/mobi_split.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_split.py
diff --git a/epy_extras/KindleUnpack/mobi_uncompress.py b/src/epy_reader/tools/KindleUnpack/mobi_uncompress.py
index c5fad85..c5fad85 100644
--- a/epy_extras/KindleUnpack/mobi_uncompress.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_uncompress.py
diff --git a/epy_extras/KindleUnpack/mobi_utils.py b/src/epy_reader/tools/KindleUnpack/mobi_utils.py
index 6791e0d..6791e0d 100644
--- a/epy_extras/KindleUnpack/mobi_utils.py
+++ b/src/epy_reader/tools/KindleUnpack/mobi_utils.py
diff --git a/epy_extras/KindleUnpack/mobiml2xhtml.py b/src/epy_reader/tools/KindleUnpack/mobiml2xhtml.py
index 94fc671..94fc671 100755
--- a/epy_extras/KindleUnpack/mobiml2xhtml.py
+++ b/src/epy_reader/tools/KindleUnpack/mobiml2xhtml.py
diff --git a/epy_extras/KindleUnpack/unipath.py b/src/epy_reader/tools/KindleUnpack/unipath.py
index 2416279..2416279 100755
--- a/epy_extras/KindleUnpack/unipath.py
+++ b/src/epy_reader/tools/KindleUnpack/unipath.py
diff --git a/epy_extras/KindleUnpack/unpack_structure.py b/src/epy_reader/tools/KindleUnpack/unpack_structure.py
index 2e66eb8..2e66eb8 100644
--- a/epy_extras/KindleUnpack/unpack_structure.py
+++ b/src/epy_reader/tools/KindleUnpack/unpack_structure.py
diff --git a/src/epy_reader/tools/__init__.py b/src/epy_reader/tools/__init__.py
new file mode 100644
index 0000000..d97cba1
--- /dev/null
+++ b/src/epy_reader/tools/__init__.py
@@ -0,0 +1,3 @@
+__all__ = ["unpack_kindle_book"]
+
+from epy_reader.tools.KindleUnpack.kindleunpack import unpackBook as unpack_kindle_book
diff --git a/src/epy_reader/utils.py b/src/epy_reader/utils.py
new file mode 100644
index 0000000..5bba7f6
--- /dev/null
+++ b/src/epy_reader/utils.py
@@ -0,0 +1,377 @@
+import curses
+import os
+import re
+import sys
+import textwrap
+from functools import wraps
+from typing import List, Mapping, Optional, Sequence, Tuple, Union
+
+from epy_reader.ebooks import URL, Azw, Ebook, Epub, FictionBook, Mobi
+from epy_reader.lib import is_url, tuple_subtract
+from epy_reader.models import Key, LettersCount, NoUpdate, ReadingState, TextStructure, TocEntry
+from epy_reader.parser import parse_html
+from epy_reader.speakers import SpeakerBaseModel, SpeakerMimic, SpeakerPico
+
+
+def get_ebook_obj(filepath: str) -> Ebook:
+ file_ext = os.path.splitext(filepath)[1].lower()
+ if is_url(filepath):
+ return URL(filepath)
+ elif file_ext in {".epub", ".epub3"}:
+ return Epub(filepath)
+ elif file_ext == ".fb2":
+ return FictionBook(filepath)
+ elif file_ext == ".mobi":
+ return Mobi(filepath)
+ elif file_ext in {".azw", ".azw3"}:
+ return Azw(filepath)
+ else:
+ sys.exit("ERROR: Format not supported. (Supported: epub, fb2)")
+
+
+def safe_curs_set(state: int) -> None:
+ try:
+ curses.curs_set(state)
+ except:
+ return
+
+
+def find_current_content_index(
+ toc_entries: Tuple[TocEntry, ...], toc_secid: Mapping[str, int], index: int, y: int
+) -> int:
+ ntoc = 0
+ for n, toc_entry in enumerate(toc_entries):
+ if toc_entry.content_index <= index:
+ if y >= toc_secid.get(toc_entry.section, 0): # type: ignore
+ ntoc = n
+ return ntoc
+
+
+def pgup(current_row: int, window_height: int, counter: int = 1) -> int:
+ if current_row >= (window_height) * counter:
+ return current_row - (window_height) * counter
+ else:
+ return 0
+
+
+def pgdn(current_row: int, total_lines: int, window_height: int, counter: int = 1) -> int:
+ if current_row + (window_height * counter) <= total_lines - window_height:
+ return current_row + (window_height * counter)
+ else:
+ current_row = total_lines - window_height
+ if current_row < 0:
+ return 0
+ return current_row
+
+
+def pgend(total_lines: int, window_height: int) -> int:
+ if total_lines - window_height >= 0:
+ return total_lines - window_height
+ else:
+ return 0
+
+
+def choice_win(allowdel=False):
+ """
+ Conjure options window by wrapping a window function
+ which has a return type of tuple in the form of
+ (title, list_to_chose, initial_active_index, windows_key_to_toggle)
+ and return tuple of (returned_key, chosen_index, chosen_index_to_delete)
+ """
+
+ def inner_f(listgen):
+ @wraps(listgen)
+ def wrapper(self, *args, **kwargs):
+ rows, cols = self.screen.getmaxyx()
+ hi, wi = rows - 4, cols - 4
+ Y, X = 2, 2
+ chwin = curses.newwin(hi, wi, Y, X)
+ if self.is_color_supported:
+ chwin.bkgd(self.screen.getbkgd())
+
+ title, ch_list, index, key = listgen(self, *args, **kwargs)
+
+ if len(title) > cols - 8:
+ title = title[: cols - 8]
+
+ chwin.box()
+ chwin.keypad(True)
+ chwin.addstr(1, 2, title)
+ chwin.addstr(2, 2, "-" * len(title))
+ if allowdel:
+ chwin.addstr(3, 2, "HINT: Press 'd' to delete.")
+ key_chwin = 0
+
+ totlines = len(ch_list)
+ chwin.refresh()
+ pad = curses.newpad(totlines, wi - 2)
+ if self.is_color_supported:
+ pad.bkgd(self.screen.getbkgd())
+
+ pad.keypad(True)
+
+ padhi = rows - 5 - Y - 4 + 1 - (1 if allowdel else 0)
+ # padhi = rows - 5 - Y - 4 + 1 - 1
+ y = 0
+ if index in range(padhi // 2, totlines - padhi // 2):
+ y = index - padhi // 2 + 1
+ span = []
+
+ for n, i in enumerate(ch_list):
+ # strs = " " + str(n+1).rjust(d) + " " + i[0]
+ # remove newline from choice entries
+ # mostly happens in FictionBook (.fb2) format
+ strs = " " + i.replace("\n", " ")
+ strs = strs[0 : wi - 3]
+ pad.addstr(n, 0, strs)
+ span.append(len(strs))
+
+ countstring = ""
+ while key_chwin not in self.keymap.Quit + key:
+ if countstring == "":
+ count = 1
+ else:
+ count = int(countstring)
+ if key_chwin in tuple(Key(i) for i in range(48, 58)): # i.e., k is a numeral
+ countstring = countstring + key_chwin.char
+ else:
+ if key_chwin in self.keymap.ScrollUp + self.keymap.PageUp:
+ index -= count
+ if index < 0:
+ index = 0
+ elif key_chwin in self.keymap.ScrollDown or key_chwin in self.keymap.PageDown:
+ index += count
+ if index + 1 >= totlines:
+ index = totlines - 1
+ elif key_chwin in self.keymap.Follow:
+ chwin.clear()
+ chwin.refresh()
+ return None, index, None
+ elif key_chwin in self.keymap.BeginningOfCh:
+ index = 0
+ elif key_chwin in self.keymap.EndOfCh:
+ index = totlines - 1
+ elif key_chwin == Key("D") and allowdel:
+ return None, (0 if index == 0 else index - 1), index
+ # chwin.redrawwin()
+ # chwin.refresh()
+ elif key_chwin == Key("d") and allowdel:
+ resk, resp, _ = self.show_win_options(
+ "Delete '{}'?".format(ch_list[index]),
+ ["(Y)es", "(N)o"],
+ 0,
+ (Key("n"),),
+ )
+ if resk is not None:
+ key_chwin = resk
+ continue
+ elif resp == 0:
+ return None, (0 if index == 0 else index - 1), index
+ chwin.redrawwin()
+ chwin.refresh()
+ elif key_chwin in {Key(i) for i in ["Y", "y", "N", "n"]} and ch_list == [
+ "(Y)es",
+ "(N)o",
+ ]:
+ if key_chwin in {Key("Y"), Key("y")}:
+ return None, 0, None
+ else:
+ return None, 1, None
+ elif key_chwin in tuple_subtract(self._win_keys, key):
+ chwin.clear()
+ chwin.refresh()
+ return key_chwin, index, None
+ countstring = ""
+
+ while index not in range(y, y + padhi):
+ if index < y:
+ y -= 1
+ else:
+ y += 1
+
+ for n in range(totlines):
+ att = curses.A_REVERSE if index == n else curses.A_NORMAL
+ pre = ">>" if index == n else " "
+ pad.addstr(n, 0, pre)
+ pad.chgat(n, 0, span[n], pad.getbkgd() | att)
+
+ pad.refresh(y, 0, Y + 4 + (1 if allowdel else 0), X + 4, rows - 5, cols - 6)
+ # pad.refresh(y, 0, Y+5, X+4, rows - 5, cols - 6)
+ key_chwin = Key(chwin.getch())
+ if key_chwin == Key(curses.KEY_MOUSE):
+ mouse_event = curses.getmouse()
+ if mouse_event[4] == curses.BUTTON4_PRESSED:
+ key_chwin = self.keymap.ScrollUp[0]
+ elif mouse_event[4] == 2097152:
+ key_chwin = self.keymap.ScrollDown[0]
+ elif mouse_event[4] == curses.BUTTON1_DOUBLE_CLICKED:
+ if (
+ mouse_event[2] >= 6
+ and mouse_event[2] < rows - 4
+ and mouse_event[2] < 6 + totlines
+ ):
+ index = mouse_event[2] - 6 + y
+ key_chwin = self.keymap.Follow[0]
+ elif (
+ mouse_event[4] == curses.BUTTON1_CLICKED
+ and mouse_event[2] >= 6
+ and mouse_event[2] < rows - 4
+ and mouse_event[2] < 6 + totlines
+ ):
+ if index == mouse_event[2] - 6 + y:
+ key_chwin = self.keymap.Follow[0]
+ continue
+ index = mouse_event[2] - 6 + y
+ elif mouse_event[4] == curses.BUTTON3_CLICKED:
+ key_chwin = self.keymap.Quit[0]
+
+ chwin.clear()
+ chwin.refresh()
+ return None, None, None
+
+ return wrapper
+
+ return inner_f
+
+
+def text_win(textfunc):
+ @wraps(textfunc)
+ def wrapper(self, *args, **kwargs) -> Union[NoUpdate, Key]:
+ rows, cols = self.screen.getmaxyx()
+ hi, wi = rows - 4, cols - 4
+ Y, X = 2, 2
+ textw = curses.newwin(hi, wi, Y, X)
+ if self.is_color_supported:
+ textw.bkgd(self.screen.getbkgd())
+
+ title, raw_texts, key = textfunc(self, *args, **kwargs)
+
+ if len(title) > cols - 8:
+ title = title[: cols - 8]
+
+ texts = []
+ for i in raw_texts.splitlines():
+ texts += textwrap.wrap(i, wi - 6, drop_whitespace=False)
+
+ textw.box()
+ textw.keypad(True)
+ textw.addstr(1, 2, title)
+ textw.addstr(2, 2, "-" * len(title))
+ key_textw: Union[NoUpdate, Key] = NoUpdate()
+
+ totlines = len(texts)
+
+ pad = curses.newpad(totlines, wi - 2)
+ if self.is_color_supported:
+ pad.bkgd(self.screen.getbkgd())
+
+ pad.keypad(True)
+ for n, i in enumerate(texts):
+ pad.addstr(n, 0, i)
+ y = 0
+ textw.refresh()
+ pad.refresh(y, 0, Y + 4, X + 4, rows - 5, cols - 6)
+ padhi = rows - 8 - Y
+
+ while key_textw not in self.keymap.Quit + key:
+ if key_textw in self.keymap.ScrollUp and y > 0:
+ y -= 1
+ elif key_textw in self.keymap.ScrollDown and y < totlines - hi + 6:
+ y += 1
+ elif key_textw in self.keymap.PageUp:
+ y = pgup(y, padhi)
+ elif key_textw in self.keymap.PageDown:
+ y = pgdn(y, totlines, padhi)
+ elif key_textw in self.keymap.BeginningOfCh:
+ y = 0
+ elif key_textw in self.keymap.EndOfCh:
+ y = pgend(totlines, padhi)
+ elif key_textw in tuple_subtract(self._win_keys, key):
+ textw.clear()
+ textw.refresh()
+ return key_textw
+ pad.refresh(y, 0, 6, 5, rows - 5, cols - 5)
+ key_textw = Key(textw.getch())
+
+ textw.clear()
+ textw.refresh()
+ return NoUpdate()
+
+ return wrapper
+
+
+def merge_text_structures(
+ text_structure_first: TextStructure, text_structure_second: TextStructure
+) -> TextStructure:
+ return TextStructure(
+ text_lines=text_structure_first.text_lines + text_structure_second.text_lines,
+ image_maps={**text_structure_first.image_maps, **text_structure_second.image_maps},
+ section_rows={**text_structure_first.section_rows, **text_structure_second.section_rows},
+ formatting=text_structure_first.formatting + text_structure_second.formatting,
+ )
+
+
+def construct_relative_reading_state(
+ abs_reading_state: ReadingState, totlines_per_content: Sequence[int]
+) -> ReadingState:
+ """
+ :param abs_reading_state: ReadingState absolute to whole book when Setting.Seamless==True
+ :param totlines_per_content: sequence of total lines per book content
+ :return: new ReadingState relative to per content of the book
+ """
+ index = 0
+ cumulative_contents_lines = 0
+ all_contents_lines = sum(totlines_per_content)
+ # for n, content_lines in enumerate(totlines_per_content):
+ # cumulative_contents_lines += content_lines
+ # if cumulative_contents_lines > abs_reading_state.row:
+ # return
+ while True:
+ content_lines = totlines_per_content[index]
+ cumulative_contents_lines += content_lines
+ if cumulative_contents_lines > abs_reading_state.row:
+ break
+ index += 1
+
+ return ReadingState(
+ content_index=index,
+ textwidth=abs_reading_state.textwidth,
+ row=abs_reading_state.row - cumulative_contents_lines + content_lines,
+ rel_pctg=abs_reading_state.rel_pctg
+ - ((cumulative_contents_lines - content_lines) / all_contents_lines)
+ if abs_reading_state.rel_pctg
+ else None,
+ section=abs_reading_state.section,
+ )
+
+
+def count_letters(ebook: Ebook) -> LettersCount:
+ per_content_counts: List[int] = []
+ cumulative_counts: List[int] = []
+ # assert isinstance(ebook.contents, tuple)
+ for i in ebook.contents:
+ content = ebook.get_raw_text(i)
+ src_lines = parse_html(content)
+ assert isinstance(src_lines, tuple)
+ cumulative_counts.append(sum(per_content_counts))
+ per_content_counts.append(sum([len(re.sub(r"\s", "", j)) for j in src_lines]))
+
+ return LettersCount(all=sum(per_content_counts), cumulative=tuple(cumulative_counts))
+
+
+def count_letters_parallel(ebook: Ebook, child_conn) -> None:
+ child_conn.send(count_letters(ebook))
+ child_conn.close()
+
+
+def construct_speaker(
+ preferred: Optional[str] = None, args: List[str] = []
+) -> Optional[SpeakerBaseModel]:
+ available_speakers = [SpeakerMimic, SpeakerPico]
+ sorted_speakers = (
+ sorted(available_speakers, key=lambda x: int(x.cmd == preferred), reverse=True)
+ if preferred
+ else available_speakers
+ )
+ speaker = next((speaker for speaker in sorted_speakers if speaker.available), None)
+ return speaker(args) if speaker else None
generated by cgit (git 2.34.1) at 2024-09-19 15:59:34 +0000