devpi-web 4.3.0__tar.gz → 5.0.0__tar.gz

{devpi-web-4.3.0 → devpi_web-5.0.0}/CHANGELOG

@@ -2,6 +2,64 @@
 
 .. towncrier release notes start
 
+5.0.0 (2025-06-12)
+==================
+
+Deprecations and Removals
+-------------------------
+
+- Removed ``macros.pt``, the contained macros have all been moved to separate templates. See other news entries for details.
+
+- Remove support for Python below 3.9. In the future end of life Python 3 versions aren't supported anymore.
+
+- Future releases will more often require newer devpi-server than before.
+
+
+
+Bug Fixes
+---------
+
+- Fix #930: remove remaining uses of unmaintained py library.
+
+
+
+Other Changes
+-------------
+
+- style.css: Added styling for readme/description code block / literals.
+
+- macros.pt (``navigation`` macro): Move ``breadcrumbs`` out of ``navigation`` macro to separate ``header_breadcrumbs.pt`` template.
+
+- macros.pt (``head`` macro): Move ``favicon`` out of ``head`` macro to separate ``favicon.pt`` template.
+
+- macros.pt: Move ``footer`` macro to separate ``footer.pt`` template.
+
+- macros.pt: Move ``head`` macro to separate ``head.pt`` template.
+
+- macros.pt: Move ``headcss`` macro to separate ``html_head_css.pt`` template.
+
+- macros.pt: Move ``headscript`` macro to separate ``html_head_scripts.pt`` template.
+
+- macros.pt: Move ``logo`` macro to separate ``logo.pt`` template.
+
+- macros.pt: Move ``navigation`` macro to separate ``header.pt`` template.
+
+- macros.pt: Move ``query_doc`` macro to separate ``query_doc.pt`` template.
+
+- macros.pt: Move ``rootaboveuserindexlist`` macro to separate ``root_above_user_index_list.pt`` template.
+
+- macros.pt: Move ``rootbelowuserindexlist`` macro to separate ``root_below_user_index_list.pt`` template.
+
+- macros.pt: Move ``search`` macro to separate ``header_search.pt`` template.
+
+- macros.pt: Move ``status`` macro to separate ``header_status.pt`` template.
+
+- macros.pt: Move ``statusbadge`` macro to separate ``status_badge.pt`` template.
+
+- macros.pt: Move ``versions`` macro to separate ``footer_versions.pt`` template.
+
+
+
 4.3.0 (2024-10-16)
 ==================
 

devpi_web-5.0.0/CHANGELOG.short.rst

@@ -0,0 +1,119 @@
+
+
+=========
+Changelog
+=========
+
+
+
+
+.. towncrier release notes start
+
+5.0.0 (2025-06-12)
+==================
+
+Deprecations and Removals
+-------------------------
+
+- Removed ``macros.pt``, the contained macros have all been moved to separate templates. See other news entries for details.
+
+- Remove support for Python below 3.9. In the future end of life Python 3 versions aren't supported anymore.
+
+- Future releases will more often require newer devpi-server than before.
+
+
+
+Bug Fixes
+---------
+
+- Fix #930: remove remaining uses of unmaintained py library.
+
+
+
+Other Changes
+-------------
+
+- style.css: Added styling for readme/description code block / literals.
+
+- macros.pt (``navigation`` macro): Move ``breadcrumbs`` out of ``navigation`` macro to separate ``header_breadcrumbs.pt`` template.
+
+- macros.pt (``head`` macro): Move ``favicon`` out of ``head`` macro to separate ``favicon.pt`` template.
+
+- macros.pt: Move ``footer`` macro to separate ``footer.pt`` template.
+
+- macros.pt: Move ``head`` macro to separate ``head.pt`` template.
+
+- macros.pt: Move ``headcss`` macro to separate ``html_head_css.pt`` template.
+
+- macros.pt: Move ``headscript`` macro to separate ``html_head_scripts.pt`` template.
+
+- macros.pt: Move ``logo`` macro to separate ``logo.pt`` template.
+
+- macros.pt: Move ``navigation`` macro to separate ``header.pt`` template.
+
+- macros.pt: Move ``query_doc`` macro to separate ``query_doc.pt`` template.
+
+- macros.pt: Move ``rootaboveuserindexlist`` macro to separate ``root_above_user_index_list.pt`` template.
+
+- macros.pt: Move ``rootbelowuserindexlist`` macro to separate ``root_below_user_index_list.pt`` template.
+
+- macros.pt: Move ``search`` macro to separate ``header_search.pt`` template.
+
+- macros.pt: Move ``status`` macro to separate ``header_status.pt`` template.
+
+- macros.pt: Move ``statusbadge`` macro to separate ``status_badge.pt`` template.
+
+- macros.pt: Move ``versions`` macro to separate ``footer_versions.pt`` template.
+
+
+
+4.3.0 (2024-10-16)
+==================
+
+Features
+--------
+
+- index.pt, project.pt, version.pt: Fix #1062: Added a link to download the documentation as zip-file to the index, project and version view.
+
+
+
+4.2.3 (2024-09-19)
+==================
+
+Bug Fixes
+---------
+
+- Fix deprecation warnings from devpi-server 6.13.0.
+
+- Lazily evaluate file information. Especially with devpi-postgresql this safes many database accesses on most pages.
+
+- Guard against missing doczip files, which can happen on replicas during replication.
+
+- Increase threshold for index status from 60 s to 300 s for warnings and from 300 s to 3600 s for fatal.
+
+
+
+4.2.2 (2024-04-20)
+==================
+
+Bug Fixes
+---------
+
+- style.css: Always let content be full browser height. This also gives more height with some documentation themes when content is short.
+
+- style.css: set ``scrollbar-gutter: stable`` on ``body`` to prevent jumping content in documentation iframe.
+
+- Fix #970: overwrite fixed html/body heights like ``100%`` in documentation iframe content.
+
+
+
+4.2.1 (2023-07-02)
+==================
+
+Bug Fixes
+---------
+
+- Fix #953: Exception when browsers send ETag for documentation pages.
+
+- Fix #980: Remove long deprecated backward compatibility for old pluggy versions to fix error with pluggy 1.1.0.
+

{devpi-web-4.3.0 → devpi_web-5.0.0}/PKG-INFO

@@ -1,36 +1,44 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: devpi-web
-Version: 4.3.0
+Version: 5.0.0
 Summary: devpi-web: a web view for devpi-server
-Home-page: https://devpi.net
-Maintainer: Florian Schulze
-Maintainer-email: mail@pyfidelity.com
-License: MIT
+Maintainer-email: Florian Schulze <mail@pyfidelity.com>
+License-Expression: MIT
 Project-URL: Bug Tracker, https://github.com/devpi/devpi/issues
 Project-URL: Changelog, https://github.com/devpi/devpi/blob/main/web/CHANGELOG
 Project-URL: Documentation, https://doc.devpi.net
+Project-URL: Homepage, https://devpi.net
 Project-URL: Source Code, https://github.com/devpi/devpi
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Web Environment
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.4
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-License-File: AUTHORS
+Requires-Dist: Whoosh<3
+Requires-Dist: attrs>=22.2.0
+Requires-Dist: beautifulsoup4!=4.12.1,>=4.3.2
+Requires-Dist: defusedxml
+Requires-Dist: devpi-server>=6.13.0
+Requires-Dist: devpi-common>=4.0.0
+Requires-Dist: docutils>=0.11
+Requires-Dist: pygments>=1.6
+Requires-Dist: pyramid>=2
+Requires-Dist: pyramid-chameleon
+Requires-Dist: readme-renderer[md]>=23.0
+Requires-Dist: tomli; python_version < "3.11"
+Dynamic: license-file
 
 ================================================
 devpi-web: web interface plugin for devpi-server
@@ -69,14 +77,74 @@ For support contracts and paid help contact ``mail at pyfidelity.com``.
 .. _GitHub Discussions: https://github.com/devpi/devpi/discussions
 
 
+
 =========
 Changelog
 =========
 
 
 
+
 .. towncrier release notes start
 
+5.0.0 (2025-06-12)
+==================
+
+Deprecations and Removals
+-------------------------
+
+- Removed ``macros.pt``, the contained macros have all been moved to separate templates. See other news entries for details.
+
+- Remove support for Python below 3.9. In the future end of life Python 3 versions aren't supported anymore.
+
+- Future releases will more often require newer devpi-server than before.
+
+
+
+Bug Fixes
+---------
+
+- Fix #930: remove remaining uses of unmaintained py library.
+
+
+
+Other Changes
+-------------
+
+- style.css: Added styling for readme/description code block / literals.
+
+- macros.pt (``navigation`` macro): Move ``breadcrumbs`` out of ``navigation`` macro to separate ``header_breadcrumbs.pt`` template.
+
+- macros.pt (``head`` macro): Move ``favicon`` out of ``head`` macro to separate ``favicon.pt`` template.
+
+- macros.pt: Move ``footer`` macro to separate ``footer.pt`` template.
+
+- macros.pt: Move ``head`` macro to separate ``head.pt`` template.
+
+- macros.pt: Move ``headcss`` macro to separate ``html_head_css.pt`` template.
+
+- macros.pt: Move ``headscript`` macro to separate ``html_head_scripts.pt`` template.
+
+- macros.pt: Move ``logo`` macro to separate ``logo.pt`` template.
+
+- macros.pt: Move ``navigation`` macro to separate ``header.pt`` template.
+
+- macros.pt: Move ``query_doc`` macro to separate ``query_doc.pt`` template.
+
+- macros.pt: Move ``rootaboveuserindexlist`` macro to separate ``root_above_user_index_list.pt`` template.
+
+- macros.pt: Move ``rootbelowuserindexlist`` macro to separate ``root_below_user_index_list.pt`` template.
+
+- macros.pt: Move ``search`` macro to separate ``header_search.pt`` template.
+
+- macros.pt: Move ``status`` macro to separate ``header_status.pt`` template.
+
+- macros.pt: Move ``statusbadge`` macro to separate ``status_badge.pt`` template.
+
+- macros.pt: Move ``versions`` macro to separate ``footer_versions.pt`` template.
+
+
+
 4.3.0 (2024-10-16)
 ==================
 
@@ -127,30 +195,3 @@ Bug Fixes
 
 - Fix #980: Remove long deprecated backward compatibility for old pluggy versions to fix error with pluggy 1.1.0.
 
-
-4.2.0 (2022-12-05)
-==================
-
-Features
---------
-
-- Set ETag header to the doczip hash and max-age to 60 seconds for all documentation files.
-
-- Add ``--keep-docs-packed`` option.
-
-
-Bug Fixes
----------
-
-- common.js, macros.pt: Fix #823: Remove moment.js and update jquery to 3.6.0.
-
-- common.js: Fix #764: Jumping to anchors with whitespace in documentation now works.
-
-- doc.pt, docview.js, style.css: Fix #764: Rewrote setting height of documentation iframe which also fixes scrolling to anchors generated by JavaScript.
-
-- Fix project names from mirrors with devpi-server >= 6.8.0.
-
-- Fix exception in not found page of project URLs.
-
-- toxresults.pt, version.pt: Fix anchor generation for toxresults URLs.
-

devpi_web-5.0.0/devpi_web/__init__.py

@@ -0,0 +1 @@
+__version__ = "5.0.0"

{devpi-web-4.3.0 → devpi_web-5.0.0}/devpi_web/clear_index.py

@@ -1,14 +1,15 @@
+from devpi_common.terminal import TerminalWriter
 from devpi_server.config import MyArgumentParser
 from devpi_server.config import add_configfile_option
 from devpi_server.config import add_help_option
 from devpi_server.config import add_storage_options
-from devpi_server.config import parseoptions, get_pluginmanager
+from devpi_server.config import get_pluginmanager
+from devpi_server.config import parseoptions
 from devpi_server.log import configure_cli_logging
 from devpi_server.main import Fatal
 from devpi_server.main import xom_from_config
 from devpi_web.config import add_indexer_backend_option
 from devpi_web.main import get_indexer
-import py
 import sys
 
 
@@ -37,6 +38,6 @@ def clear_index(argv=None):
         ix.delete_index()
         log.info("Index deleted, start devpi-server again to let the index rebuild automatically.")
     except Fatal as e:
-        tw = py.io.TerminalWriter(sys.stderr)
+        tw = TerminalWriter(sys.stderr)
         tw.line("fatal: %s" % e.args[0], red=True)
         return 1

devpi_web-5.0.0/devpi_web/compat.py

@@ -0,0 +1,9 @@
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib
+
+
+__all__ = [
+    "tomllib",
+]

{devpi-web-4.3.0 → devpi_web-5.0.0}/devpi_web/doczip.py

@@ -1,13 +1,15 @@
 from bs4 import BeautifulSoup
-from collections.abc import MutableMapping as DictMixin
+from collections.abc import MutableMapping
 from contextlib import contextmanager
+from contextlib import suppress
 from devpi_common.archive import Archive
 from devpi_common.types import cached_property
 from devpi_common.validation import normalize_name
 from devpi_server.log import threadlog
-from devpi_web.compat import get_entry_hash_spec
+from pathlib import Path
+import itertools
 import json
-import py
+import shutil
 
 
 try:
@@ -18,21 +20,20 @@ except ImportError:
 
 def get_unpack_path(stage, name, version):
     path = stage.xom.config.args.documentation_path
-    if path is None:
-        path = py.path.local(stage.keyfs.base_path) if hasattr(stage.keyfs, "base_path") else stage.keyfs.basedir
-    else:
-        path = py.path.local(path)
-    return path.join(
-        stage.user.name, stage.index, normalize_name(name), version, "+doc")
+    path = stage.keyfs.base_path if path is None else Path(path)
+    return path.joinpath(
+        stage.user.name, stage.index, normalize_name(name), version, "+doc"
+    )
 
 
 @contextmanager
-def locked_unpack_path(stage, name, version, remove_lock_file=False):
+def locked_unpack_path(stage, name, version, *, remove_lock_file=False):
     unpack_path = get_unpack_path(stage, name, version)
     # we are using the hash file as a lock file
-    hash_path = unpack_path.new(ext="hash")
+    hash_path = unpack_path.with_suffix(".hash")
     try:
-        with hash_path.open("a+", ensure=True) as hash_file:
+        hash_path.parent.mkdir(parents=True, exist_ok=True)
+        with hash_path.open("a+") as hash_file:
             if fcntl:
                 fcntl.flock(hash_file, fcntl.LOCK_EX)
             try:
@@ -42,11 +43,9 @@ def locked_unpack_path(stage, name, version, remove_lock_file=False):
                     fcntl.flock(hash_file, fcntl.LOCK_UN)
     finally:
         if remove_lock_file and hash_path.exists():
-            try:
-                hash_path.remove()
-            except py.error.ENOENT:
+            with suppress(FileNotFoundError):
                 # there is a rare possibility of a race condition here
-                pass
+                hash_path.unlink()
 
 
 def keep_docs_packed(config):
@@ -60,23 +59,21 @@ def docs_exist(stage, name, version, entry):
 def docs_file_content(stage, name, version, entry, relpath):
     if not keep_docs_packed(stage.xom.config):
         return None
-    with entry.file_open_read() as f:
-        with Archive(f) as archive:
-            return archive.read(relpath)
+    with entry.file_open_read() as f, Archive(f) as archive:
+        return archive.read(relpath)
 
 
 def docs_file_exists(stage, name, version, entry, relpath):
     if keep_docs_packed(stage.xom.config):
-        with entry.file_open_read() as f:
-            with Archive(f) as archive:
-                try:
-                    if archive.getfile(relpath):
-                        return True
-                except archive.FileNotExist:
-                    return False
+        with entry.file_open_read() as f, Archive(f) as archive:
+            try:
+                if archive.getfile(relpath):
+                    return True
+            except archive.FileNotExist:
+                return False
     else:
         doc_path = unpack_docs(stage, name, version, entry)
-        if doc_path.join(relpath).isfile():
+        if doc_path.joinpath(relpath).is_file():
             return True
     return False
 
@@ -85,7 +82,7 @@ def docs_file_path(stage, name, version, entry, relpath):
     if keep_docs_packed(stage.xom.config):
         return None
     doc_path = unpack_docs(stage, name, version, entry)
-    return doc_path.join(relpath)
+    return doc_path.joinpath(relpath)
 
 
 def unpack_docs(stage, name, version, entry):
@@ -93,21 +90,18 @@ def unpack_docs(stage, name, version, entry):
     # we are not losing the original zip file anyway
     with locked_unpack_path(stage, name, version) as (hash_file, unpack_path):
         hash_file.seek(0)
-        if hash_file.read().strip() == get_entry_hash_spec(entry):
+        if hash_file.read().strip() == entry.best_available_hash_spec:
             return unpack_path
         if unpack_path.exists():
-            try:
-                unpack_path.remove()
-            except py.error.ENOENT:
+            with suppress(FileNotFoundError):
                 # there is a rare possibility of a race condition here
-                pass
+                unpack_path.unlink()
         if not entry.file_exists():
             return unpack_path
-        with entry.file_open_read() as f:
-            with Archive(f) as archive:
-                archive.extract(unpack_path)
+        with entry.file_open_read() as f, Archive(f) as archive:
+            archive.extract(unpack_path)
         hash_file.seek(0)
-        hash_file.write(get_entry_hash_spec(entry))
+        hash_file.write(entry.best_available_hash_spec)
         hash_file.truncate()
         threadlog.debug("%s: unpacked %s-%s docs to %s",
                         stage.name, name, version, unpack_path)
@@ -115,17 +109,18 @@ def unpack_docs(stage, name, version, entry):
 
 
 class PackedEntry:
-    def __init__(self, basename, body):
-        self.basename = basename
+    def __init__(self, name, body):
+        self.name = name
         self.body = body
 
-    def read(self, mode='rb'):
-        if mode != 'rb':
-            raise RuntimeError("Unsupported mode %r" % mode)
+    def read_bytes(self):
         return self.body
 
+    def read_text(self):
+        return self.body.decode()
+
 
-class Docs(DictMixin):
+class Docs(MutableMapping):
     def __init__(self, stage, name, version):
         self.stage = stage
         self.keep_docs_packed = keep_docs_packed(self.stage.xom.config)
@@ -148,40 +143,43 @@ class Docs(DictMixin):
             # aren't uploaded yet
             threadlog.warn("Tried to access %s, but it doesn't exist.", self.unpack_path)
             return {}
-        if self.keep_docs_packed:
-            return self._packed_entries()
-        else:
-            return self._unpacked_entries()
+        return (
+            self._packed_entries()
+            if self.keep_docs_packed
+            else self._unpacked_entries()
+        )
 
     def _packed_entries(self):
         html = set()
         fjson = set()
-        with self.entry.file_open_read() as f:
-            with Archive(f) as archive:
-                for item in archive.namelist():
-                    if item.endswith('.fjson'):
-                        fjson.add(item)
-                    elif item.endswith('.html'):
-                        html.add(item)
-                if fjson:
-                    # if there is fjson, then we get structured data
-                    # see http://www.sphinx-doc.org/en/master/usage/builders/index.html#serialization-builder-details
-                    return {
-                        k[:-6]: PackedEntry(k, archive.read(k))
-                        for k in fjson}
-                else:
-                    return {
-                        k[:-5]: PackedEntry(k, archive.read(k))
-                        for k in html}
+        with self.entry.file_open_read() as f, Archive(f) as archive:
+            for item in archive.namelist():
+                if item.endswith(".fjson"):
+                    fjson.add(item)
+                elif item.endswith(".html"):
+                    html.add(item)
+            if fjson:
+                # if there is fjson, then we get structured data
+                # see http://www.sphinx-doc.org/en/master/usage/builders/index.html#serialization-builder-details
+                src = fjson
+                s = slice(None, -6)
+            else:
+                src = html
+                s = slice(None, -5)
+            return {k[s]: PackedEntry(k, archive.read(k)) for k in src}
 
     def _unpacked_entries(self):
         unpack_path = unpack_docs(self.stage, self.name, self.version, self.entry)
-        if not unpack_path.isdir():
+        if not unpack_path.is_dir():
             return {}
         html = []
         fjson = []
-        for entry in unpack_path.visit():
-            basename = entry.basename
+        entries = itertools.chain(
+            unpack_path.glob("**/*.fjson"),
+            unpack_path.glob("**/*.html"),
+        )
+        for entry in entries:
+            basename = entry.name
             if basename.endswith('.fjson'):
                 fjson.append(entry)
             elif basename.endswith('.html'):
@@ -189,9 +187,12 @@ class Docs(DictMixin):
         if fjson:
             # if there is fjson, then we get structured data
             # see http://www.sphinx-doc.org/en/master/usage/builders/index.html#serialization-builder-details
-            return {x.relto(unpack_path)[:-6]: x for x in fjson}
+            src = fjson
+            s = slice(None, -6)
         else:
-            return {x.relto(unpack_path)[:-5]: x for x in html}
+            src = html
+            s = slice(None, -5)
+        return {str(x.relative_to(unpack_path))[s]: x for x in src}
 
     def keys(self):
         return self._entries.keys()
@@ -210,26 +211,19 @@ class Docs(DictMixin):
 
     def __getitem__(self, name):
         entry = self._entries[name]
-        if entry.basename.endswith('.fjson'):
-            info = json.loads(entry.read())
+        if entry.name.endswith(".fjson"):
+            info = json.loads(entry.read_text())
             return dict(
                 title=BeautifulSoup(info.get('title', ''), "html.parser").text,
                 text=BeautifulSoup(info.get('body', ''), "html.parser").text,
                 path=info.get('current_page_name', name))
-        else:
-            soup = BeautifulSoup(entry.read(mode='rb'), "html.parser")
-            body = soup.find('body')
-            if body is None:
-                return
-            title = soup.find('title')
-            if title is None:
-                title = ''
-            else:
-                title = title.text
-            return dict(
-                title=title,
-                text=body.text,
-                path=name)
+        soup = BeautifulSoup(entry.read_bytes(), "html.parser")
+        body = soup.find("body")
+        if body is None:
+            return None
+        title = soup.find("title")
+        title = "" if title is None else title.text
+        return dict(title=title, text=body.text, path=name)
 
 
 def remove_docs(stage, project, version):
@@ -237,8 +231,8 @@ def remove_docs(stage, project, version):
         # the stage was removed
         return
     with locked_unpack_path(stage, project, version, remove_lock_file=True) as (hash_file, directory):
-        if not directory.isdir():
+        if not directory.is_dir():
             threadlog.debug("ignoring lost unpacked docs: %s" % directory)
         else:
             threadlog.debug("removing unpacked docs: %s" % directory)
-            directory.remove()
+            shutil.rmtree(directory)

{devpi-web-4.3.0 → devpi_web-5.0.0}/devpi_web/indexing.py

@@ -34,6 +34,7 @@ def preprocess_project(project):
     if not stage.has_project_perstage(name):
         # project doesn't exist anymore
         return
+    # metadata_keys is only available on private indexes
     setuptools_metadata = frozenset(getattr(stage, 'metadata_keys', ()))
     versions = get_sorted_versions(stage.list_versions_perstage(name))
     result = dict(name=project.name)