reader 3.18__tar.gz → 3.19.dev0__tar.gz

{reader-3.18 → reader-3.19.dev0}/CHANGES.rst

@@ -6,6 +6,20 @@ Changelog
   :no-index:
 
 
+Version 3.19
+------------
+
+Unreleased
+
+* Support Python 3.14.
+
+* :mod:`~reader._plugins.enclosure_tags` plugin:
+  strip HTML tags from values used as MP3 tags
+  (for example, ``<b>`` tags used to highlight search result matches).
+
+* Remove long-deprecated, empty ``search`` and ``readtime`` extras.
+
+
 Version 3.18
 ------------
 

{reader-3.18/src/reader.egg-info → reader-3.19.dev0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: reader
-Version: 3.18
+Version: 3.19.dev0
 Summary: A Python feed reader library.
 Author: lemon24
 License: BSD-3-Clause
 Project-URL: Documentation, https://reader.readthedocs.io/
-Project-URL: Changes, https://reader.readthedocs.io/en/latest/changelog.html
-Project-URL: Source Code, https://github.com/lemon24/reader
-Project-URL: Issue tracker, https://github.com/lemon24/reader/issues
+Project-URL: Repository, https://github.com/lemon24/reader
+Project-URL: Issues, https://github.com/lemon24/reader/issues
+Project-URL: Changelog, https://reader.readthedocs.io/en/latest/changelog.html
 Keywords: atom,cdf,feed,rdf,rss,json feed,web feed,podcast,feed reader,feed aggregator
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Internet
@@ -40,14 +41,14 @@ Requires-Dist: requests>=2.18
 Requires-Dist: werkzeug>2
 Requires-Dist: iso8601>=1
 Requires-Dist: beautifulsoup4>=4.5
-Provides-Extra: search
-Provides-Extra: readtime
+Provides-Extra: all
+Requires-Dist: reader[app,cli,unstable-plugins]; extra == "all"
 Provides-Extra: cli
 Requires-Dist: click>=7; extra == "cli"
 Requires-Dist: PyYAML; extra == "cli"
 Provides-Extra: app
 Requires-Dist: flask>=0.10; extra == "app"
-Requires-Dist: humanize!=4.7.*,>=4; extra == "app"
+Requires-Dist: humanize>=4; extra == "app"
 Requires-Dist: PyYAML; extra == "app"
 Requires-Dist: WTForms; extra == "app"
 Requires-Dist: jinja2-fragments; extra == "app"
@@ -59,36 +60,6 @@ Requires-Dist: beautifulsoup4; extra == "unstable-plugins"
 Requires-Dist: blinker>=1.4; extra == "unstable-plugins"
 Requires-Dist: beautifulsoup4; extra == "unstable-plugins"
 Requires-Dist: tabulate; extra == "unstable-plugins"
-Provides-Extra: tests
-Requires-Dist: pytest>=4; extra == "tests"
-Requires-Dist: pytest-randomly; extra == "tests"
-Requires-Dist: pytest-subtests; extra == "tests"
-Requires-Dist: pytest-rerunfailures; extra == "tests"
-Requires-Dist: coverage; extra == "tests"
-Requires-Dist: pytest-cov; extra == "tests"
-Requires-Dist: requests-mock; extra == "tests"
-Requires-Dist: mechanicalsoup; (implementation_name != "pypy" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: requests-wsgi-adapter; extra == "tests"
-Requires-Dist: lxml; (implementation_name != "pypy" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: html5lib; extra == "tests"
-Requires-Dist: numpy; (implementation_name != "pypy" and os_name == "posix" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: mypy; implementation_name != "pypy" and extra == "tests"
-Requires-Dist: types-requests; extra == "tests"
-Requires-Dist: types-beautifulsoup4; extra == "tests"
-Provides-Extra: docs
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx-rtd-theme>=1.3.0rc1; extra == "docs"
-Requires-Dist: click>=7; extra == "docs"
-Requires-Dist: sphinx-click; extra == "docs"
-Requires-Dist: sphinx-hoverxref; extra == "docs"
-Requires-Dist: sphinxcontrib-log-cabinet; extra == "docs"
-Requires-Dist: setuptools; extra == "docs"
-Provides-Extra: dev
-Requires-Dist: reader[app,cli,docs,tests,unstable-plugins]; extra == "dev"
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
 .. begin-intro

{reader-3.18 → reader-3.19.dev0}/docs/conf.py

@@ -33,7 +33,6 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.extlinks',
     'sphinx_click.ext',
-    'hoverxref.extension',
     'sphinxcontrib.log_cabinet',
 ]
 
@@ -112,19 +111,6 @@ extlinks = {
 }
 
 
-hoverxref_auto_ref = True
-hoverxref_domains = ["py"]
-hoverxref_role_types = {
-    'ref': 'tooltip',
-    'mod': 'tooltip',
-    'class': 'tooltip',
-    'meth': 'tooltip',
-    'attr': 'tooltip',
-    'exc': 'tooltip',
-    'func': 'tooltip',
-    'data': 'tooltip',
-}
-
 pygments_style = 'friendly'
 
 html_theme = 'sphinx_rtd_theme'

{reader-3.18 → reader-3.19.dev0}/docs/install.rst

@@ -109,11 +109,13 @@ Use the following command to update *reader*
     pip install --upgrade reader
 
 
+.. _install-pre-release:
+
 Living on the edge
 ~~~~~~~~~~~~~~~~~~
 
 If you want to use the latest *reader* code before it’s released,
-install or update from the master branch:
+install or update from the ``master`` branch:
 
 .. code-block:: bash
 

{reader-3.18 → reader-3.19.dev0}/pyproject.toml

@@ -1,7 +1,3 @@
-[build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
-
 [project]
 name = "reader"
 authors = [{name = "lemon24"}]
@@ -26,6 +22,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
     "Topic :: Internet",
@@ -52,19 +49,16 @@ dynamic = ["version"]
 
 [project.urls]
 Documentation = "https://reader.readthedocs.io/"
-Changes = "https://reader.readthedocs.io/en/latest/changelog.html"
-"Source Code" = "https://github.com/lemon24/reader"
-"Issue tracker" = "https://github.com/lemon24/reader/issues"
+Repository = "https://github.com/lemon24/reader"
+Issues = "https://github.com/lemon24/reader/issues"
+Changelog = "https://reader.readthedocs.io/en/latest/changelog.html"
 
 [project.optional-dependencies]
 
-# STABLE
-
-search = []  # empty since 2.4, kept to avoid breaking dependents
-readtime = []  # empty since 3.1, kept to avoid breaking dependents
-
 # UNSTABLE
 
+all = ["reader[cli,app,unstable-plugins]"]
+
 cli = [
     "click>=7",
     # for config
@@ -72,8 +66,7 @@ cli = [
 ]
 app = [
     "flask>=0.10",
-    # https://github.com/python-humanize/humanize/issues/122
-    "humanize>=4,!=4.7.*",
+    "humanize>=4",
     # for config
     "PyYAML",
     # for v2
@@ -81,8 +74,6 @@ app = [
     "jinja2-fragments",
 ]
 
-# UNSTABLE PLUGINS
-
 # mushed together for convenience
 unstable-plugins = [
     # enclosure-tags
@@ -98,16 +89,14 @@ unstable-plugins = [
     "tabulate",
 ]
 
-# DEVELOPMENT
+[dependency-groups]
 
-# run tests under one interpreter
 tests = [
     "pytest>=4",
     "pytest-randomly",
     "pytest-subtests",
     "pytest-rerunfailures",
     "coverage",
-    "pytest-cov",
     "requests-mock",
     # mechanicalsoup hard-depends on lxml (see below)
     'mechanicalsoup; (implementation_name != "pypy" and python_version <= "3.12")',
@@ -119,35 +108,38 @@ tests = [
     "html5lib",
     # for bench.py
     'numpy; (implementation_name != "pypy" and os_name == "posix" and python_version <= "3.12")',
-    # mypy does not work on pypy (yet).
-    'mypy; implementation_name != "pypy"',
+]
+
+typing = [
+    'mypy',
     "types-requests",
     "types-beautifulsoup4",
 ]
 
-# build docs
 docs = [
     "sphinx",
-    # listing 1.3.0rc1 explicitly until 1.3 is released
-    # https://github.com/readthedocs/sphinx_rtd_theme/pull/1464#issuecomment-1664799982
-    "sphinx-rtd-theme>=1.3.0rc1",
+    "sphinx-rtd-theme",
     "click>=7",
     "sphinx-click",
-    "sphinx-hoverxref",
     "sphinxcontrib-log-cabinet",
     # for read_configuration used in conf.py
     "setuptools",
 ]
 
-# things needed to develop / test locally / make releases
 dev = [
-    "reader[cli,app,unstable-plugins,tests,docs]",
+    {include-group = "tests"},
+    {include-group = "typing"},
+    {include-group = "docs"},
     "tox",
     "pre-commit",
     "build",
     "twine",
 ]
 
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
 [tool.setuptools.dynamic]
 version = {attr = "reader.__version__"}
 
@@ -170,9 +162,16 @@ source = ["reader", "tests"]
 omit = [
     "src/reader/_vendor/*",
 ]
+# TODO: remove when https://github.com/nedbat/coveragepy/issues/1987 is solved
+core = "ctrace"
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]
 
+[tool.mypy]
+files = ["src"]
+show_error_codes = true
+pretty = true
+strict = true
 [[tool.mypy.overrides]]
 module = [
     "reader.__main__",

reader-3.19.dev0/run.sh

@@ -0,0 +1,125 @@
+#!/bin/bash
+#
+# usage: ./run.sh command [argument ...]
+#
+# Executable documentation for the development workflow.
+#
+# See https://death.andgravity.com/run-sh for how this works.
+
+
+# preamble
+
+set -o nounset
+set -o pipefail
+set -o errexit
+
+PROJECT_ROOT=${0%/*}
+if [[ $0 != $PROJECT_ROOT && $PROJECT_ROOT != "" ]]; then
+    cd "$PROJECT_ROOT"
+fi
+readonly PROJECT_ROOT=$( pwd )
+readonly SCRIPT="$PROJECT_ROOT/$( basename "$0" )"
+
+
+# main development workflow
+
+function install {
+    pip install -e '.[all]' --group dev --upgrade --upgrade-strategy eager
+    pre-commit install --install-hooks
+}
+
+function test {
+    pytest --runslow "$@"
+}
+
+function test-all {
+    tox run-parallel "$@"
+}
+
+function coverage {
+    unset -f coverage
+    coverage run -m pytest --runslow "$@"
+    coverage html
+    coverage-report
+}
+
+function typing {
+    mypy "$@"
+}
+
+function docs {
+    sphinx-build -E -W docs docs/_build/html "$@"
+}
+
+
+# "watch" versions of the main commands
+
+function test-dev {
+    watch pytest "$@"
+}
+
+function typing-dev {
+    watch typing "$@"
+}
+
+function docs-dev {
+    rm -r docs/_build/html
+    watch sphinx-build -W docs docs/_build/html "$@"
+}
+
+function serve-dev {
+    export READER_DB=db.sqlite
+    flask -A reader._app.wsgi --debug run "$@"
+}
+
+
+# low level commands
+
+function coverage-report {
+    # --fail-under only for the library, not the CLI or the web app
+    unset -f coverage
+    coverage report \
+        --omit "$(
+            echo "
+                */reader/_vendor/*
+                */reader/__main__.py
+                */reader/_cli*
+                */reader/_config*
+                */reader/_app/*
+                */reader/_plugins/*
+                tests/*
+            " | xargs echo | sed 's/ /,/g'
+        )" \
+        --skip-covered \
+        --show-missing \
+        --fail-under $( on-pypy && echo 99 || echo 100 )
+}
+
+
+# utilities
+
+function on-pypy {
+    [[ $( python -c 'import sys; print(sys.implementation.name)' ) == pypy ]]
+}
+
+function watch {
+    entr-project-files -cdr "$SCRIPT" "$@"
+}
+
+function entr-project-files {
+    set +o errexit
+    while true; do
+        ls-project-files | entr "$@"
+        if [[ $? -eq 0 ]]; then
+            break
+        fi
+    done
+}
+
+function ls-project-files {
+    git ls-files "$@"
+    git ls-files --exclude-standard --others "$@"
+}
+
+
+"$@"

{reader-3.18 → reader-3.19.dev0}/src/reader/__init__.py

@@ -37,7 +37,7 @@ Print the titles of the unread entries::
 
 """
 
-__version__ = '3.18'
+__version__ = '3.19.dev0'
 
 # isort: off
 

{reader-3.18 → reader-3.19.dev0}/src/reader/_plugins/enclosure_tags.py

@@ -38,6 +38,7 @@ from flask import request
 from flask import Response
 from flask import stream_with_context
 from flask import url_for
+from jinja2.filters import do_striptags as striptags
 
 
 blueprint = Blueprint('enclosure_tags', __name__)
@@ -146,12 +147,13 @@ def enclosure_tags_filter(enclosure, entry, feed_tags):
 
     args = {'url': enclosure.href, 'filename': filename}
     if entry.title:
-        args['title'] = entry.title
+        args['title'] = striptags(entry.title)
     if album := (entry.feed.user_title or entry.feed.title):
+        album = striptags(album)
         args['album'] = album
         args['artist'] = album
     elif artist := (entry.author or entry.feed.author):
-        args['artist'] = artist
+        args['artist'] = striptags(artist)
 
     for tag in feed_tags:
         if 'podcast' in tag.lower():

{reader-3.18 → reader-3.19.dev0}/src/reader/_storage/_sqlite_utils.py

@@ -23,6 +23,7 @@ from dataclasses import dataclass
 from datetime import datetime
 from datetime import timezone
 from typing import Any
+from typing import cast
 from typing import no_type_check
 from typing import TypeVar
 
@@ -471,8 +472,9 @@ class LocalConnectionFactory:
         if not self._local.is_creating_thread:
             self._other_threads = True
 
-        self._local.db = db = sqlite3.connect(self.path, **self.kwargs)
-        assert db is not None, "for mypy"
+        # TODO: remove needless cast (needed after mypy 1.16.0 update)
+        db = cast(sqlite3.Connection, sqlite3.connect(self.path, **self.kwargs))
+        self._local.db = db
         self._local.call_count = 0
 
         try:

{reader-3.18 → reader-3.19.dev0}/src/reader/types.py

@@ -757,7 +757,7 @@ class EntrySort(enum.StrEnum):
     #:
     #: .. note::
     #:
-    #: The algorithm for "recent" is a heuristic and may change over time.
+    #:  The algorithm for "recent" is a heuristic and may change over time.
     #:
     #: .. versionchanged:: 3.1
     #:  Sort entries by added date most of the time,

{reader-3.18 → reader-3.19.dev0/src/reader.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: reader
-Version: 3.18
+Version: 3.19.dev0
 Summary: A Python feed reader library.
 Author: lemon24
 License: BSD-3-Clause
 Project-URL: Documentation, https://reader.readthedocs.io/
-Project-URL: Changes, https://reader.readthedocs.io/en/latest/changelog.html
-Project-URL: Source Code, https://github.com/lemon24/reader
-Project-URL: Issue tracker, https://github.com/lemon24/reader/issues
+Project-URL: Repository, https://github.com/lemon24/reader
+Project-URL: Issues, https://github.com/lemon24/reader/issues
+Project-URL: Changelog, https://reader.readthedocs.io/en/latest/changelog.html
 Keywords: atom,cdf,feed,rdf,rss,json feed,web feed,podcast,feed reader,feed aggregator
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Internet
@@ -40,14 +41,14 @@ Requires-Dist: requests>=2.18
 Requires-Dist: werkzeug>2
 Requires-Dist: iso8601>=1
 Requires-Dist: beautifulsoup4>=4.5
-Provides-Extra: search
-Provides-Extra: readtime
+Provides-Extra: all
+Requires-Dist: reader[app,cli,unstable-plugins]; extra == "all"
 Provides-Extra: cli
 Requires-Dist: click>=7; extra == "cli"
 Requires-Dist: PyYAML; extra == "cli"
 Provides-Extra: app
 Requires-Dist: flask>=0.10; extra == "app"
-Requires-Dist: humanize!=4.7.*,>=4; extra == "app"
+Requires-Dist: humanize>=4; extra == "app"
 Requires-Dist: PyYAML; extra == "app"
 Requires-Dist: WTForms; extra == "app"
 Requires-Dist: jinja2-fragments; extra == "app"
@@ -59,36 +60,6 @@ Requires-Dist: beautifulsoup4; extra == "unstable-plugins"
 Requires-Dist: blinker>=1.4; extra == "unstable-plugins"
 Requires-Dist: beautifulsoup4; extra == "unstable-plugins"
 Requires-Dist: tabulate; extra == "unstable-plugins"
-Provides-Extra: tests
-Requires-Dist: pytest>=4; extra == "tests"
-Requires-Dist: pytest-randomly; extra == "tests"
-Requires-Dist: pytest-subtests; extra == "tests"
-Requires-Dist: pytest-rerunfailures; extra == "tests"
-Requires-Dist: coverage; extra == "tests"
-Requires-Dist: pytest-cov; extra == "tests"
-Requires-Dist: requests-mock; extra == "tests"
-Requires-Dist: mechanicalsoup; (implementation_name != "pypy" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: requests-wsgi-adapter; extra == "tests"
-Requires-Dist: lxml; (implementation_name != "pypy" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: html5lib; extra == "tests"
-Requires-Dist: numpy; (implementation_name != "pypy" and os_name == "posix" and python_version <= "3.12") and extra == "tests"
-Requires-Dist: mypy; implementation_name != "pypy" and extra == "tests"
-Requires-Dist: types-requests; extra == "tests"
-Requires-Dist: types-beautifulsoup4; extra == "tests"
-Provides-Extra: docs
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx-rtd-theme>=1.3.0rc1; extra == "docs"
-Requires-Dist: click>=7; extra == "docs"
-Requires-Dist: sphinx-click; extra == "docs"
-Requires-Dist: sphinx-hoverxref; extra == "docs"
-Requires-Dist: sphinxcontrib-log-cabinet; extra == "docs"
-Requires-Dist: setuptools; extra == "docs"
-Provides-Extra: dev
-Requires-Dist: reader[app,cli,docs,tests,unstable-plugins]; extra == "dev"
-Requires-Dist: tox; extra == "dev"
-Requires-Dist: pre-commit; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
 .. begin-intro

{reader-3.18 → reader-3.19.dev0}/src/reader.egg-info/SOURCES.txt

@@ -5,8 +5,6 @@ README.rst
 pyproject.toml
 run.sh
 tox.ini
-docs/.DS_Store
-docs/Makefile
 docs/api.rst
 docs/app.rst
 docs/changelog.rst
@@ -20,7 +18,6 @@ docs/guide.rst
 docs/index.rst
 docs/install.rst
 docs/internal.rst
-docs/make.bat
 docs/plugins.rst
 docs/tutorial.rst
 docs/why.rst
@@ -41,11 +38,9 @@ examples/feed_slugs.py
 examples/parser_only.py
 examples/podcast.py
 examples/terminal.py
-scripts/.coverage
 scripts/backup.sh
 scripts/bench.py
 scripts/debug_storage_stats.py
-scripts/generate_import_all.py
 scripts/jscontrols.html
 scripts/jscontrols.py
 scripts/lines.sh
@@ -201,7 +196,6 @@ tests/test_sql_utils.py
 tests/test_sqlite_utils.py
 tests/test_storage.py
 tests/test_tags.py
-tests/test_test_utils.py
 tests/test_types.py
 tests/utils.py
 tests/data/10.json

reader-3.19.dev0/src/reader.egg-info/requires.txt

@@ -0,0 +1,27 @@
+typing-extensions>=4
+feedparser>=6
+requests>=2.18
+werkzeug>2
+iso8601>=1
+beautifulsoup4>=4.5
+
+[all]
+reader[app,cli,unstable-plugins]
+
+[app]
+flask>=0.10
+humanize>=4
+PyYAML
+WTForms
+jinja2-fragments
+
+[cli]
+click>=7
+PyYAML
+
+[unstable-plugins]
+requests
+mutagen
+beautifulsoup4
+blinker>=1.4
+tabulate

{reader-3.18 → reader-3.19.dev0}/tests/conftest.py

@@ -11,6 +11,7 @@ import reader_methods
 from fakeparser import Parser
 from reader import make_reader as original_make_reader
 from reader._storage import Storage
+from utils import monkeypatch_os
 from utils import monkeypatch_tz
 from utils import reload_module