Bootstrap on package view page

Author: chriskuehl

pypi_view/app.py

@@ -1,11 +1,13 @@
 import email
 import io
+import itertools
 import mimetypes
 import os.path
 import re
 
 import fluffy_code.code
 import fluffy_code.prebuilt_styles
+import packaging.version
 import pygments.lexers.special
 from identify import identify
 from starlette.applications import Starlette
@@ -19,13 +21,18 @@
 from starlette.staticfiles import StaticFiles
 from starlette.templating import Jinja2Templates
 
-from pypi_view import packaging
+import pypi_view.packaging
 from pypi_view import pypi
 
 PACKAGE_TYPE_NOT_SUPPORTED_ERROR = (
     'Sorry, this package type is not yet supported (only .zip and .whl supported currently).'
 )
-TEXT_RENDER_FILESIZE_LIMIT = 20 * 1024  # 20 KiB
+
+ONE_KB = 2**10
+ONE_MB = 2**20
+ONE_GB = 2**30
+
+TEXT_RENDER_FILESIZE_LIMIT = 50 * ONE_KB
 
 # Mime types which are allowed to be presented as detected.
 # TODO: I think we actually only need to prevent text/html (and any HTML
@@ -81,6 +88,25 @@ async def dispatch(self, request, call_next):
 )
 
 
+def _pluralize(n: int) -> str:
+    return '' if n == 1 else 's'
+
+
+def _human_size(size: int) -> str:
+    if size >= ONE_GB:
+        return f'{size / ONE_GB:.1f} GiB'
+    elif size >= ONE_MB:
+        return f'{size / ONE_MB:.1f} MiB'
+    elif size >= ONE_KB:
+        return f'{size / ONE_KB:.1f} KiB'
+    else:
+        return '{} {}{}'.format(size, 'byte', _pluralize(size))
+
+
+templates.env.filters['human_size'] = _human_size
+templates.env.filters['pluralize'] = _pluralize
+
+
 @app.route('/')
 async def home(request: Request) -> Response:
     return templates.TemplateResponse('home.html', {'request': request})
@@ -89,6 +115,10 @@ async def home(request: Request) -> Response:
 @app.route('/package/{package}')
 async def package(request: Request) -> Response:
     package_name = request.path_params['package']
+    normalized_package_name = pypi_view.packaging.pep426_normalize(package_name)
+    if package_name != normalized_package_name:
+        return RedirectResponse(request.url_for('package', package=normalized_package_name))
+
     try:
         version_to_files = await pypi.files_for_package(package_name)
     except pypi.PackageDoesNotExist:
@@ -97,12 +127,18 @@ async def package(request: Request) -> Response:
             status_code=404,
         )
     else:
+        version_to_files_sorted = sorted(
+            version_to_files.items(),
+            key=lambda item: packaging.version.parse(item[0]),
+            reverse=True,
+        )
         return templates.TemplateResponse(
             'package.html',
             {
                 'request': request,
                 'package': package_name,
-                'version_to_files': version_to_files,
+                'version_to_files': version_to_files_sorted,
+                'total_files': len(set(itertools.chain.from_iterable(version_to_files.values()))),
             },
         )
 
@@ -111,6 +147,17 @@ async def package(request: Request) -> Response:
 async def package_file(request: Request) -> Response:
     package_name = request.path_params['package']
     file_name = request.path_params['filename']
+
+    normalized_package_name = pypi_view.packaging.pep426_normalize(package_name)
+    if package_name != normalized_package_name:
+        return RedirectResponse(
+            request.url_for(
+                'package_file',
+                package=normalized_package_name,
+                filename=file_name,
+            ),
+        )
+
     try:
         archive = await pypi.downloaded_file_path(package_name, file_name)
     except pypi.PackageDoesNotExist:
@@ -125,8 +172,8 @@ async def package_file(request: Request) -> Response:
         )
 
     try:
-        package = packaging.Package.from_path(archive)
-    except packaging.UnsupportedPackageType:
+        package = pypi_view.packaging.Package.from_path(archive)
+    except pypi_view.packaging.UnsupportedPackageType:
         return PlainTextResponse(
             PACKAGE_TYPE_NOT_SUPPORTED_ERROR,
             status_code=501,
@@ -173,6 +220,18 @@ async def package_file_archive_path(request: Request) -> Response:
     package_name = request.path_params['package']
     file_name = request.path_params['filename']
     archive_path = request.path_params['archive_path']
+
+    normalized_package_name = pypi_view.packaging.pep426_normalize(package_name)
+    if package_name != normalized_package_name:
+        return RedirectResponse(
+            request.url_for(
+                'package_file_archive_path',
+                package=normalized_package_name,
+                filename=file_name,
+                archive_path=archive_path,
+            ),
+        )
+
     try:
         archive = await pypi.downloaded_file_path(package_name, file_name)
     except pypi.PackageDoesNotExist:
@@ -186,8 +245,8 @@ async def package_file_archive_path(request: Request) -> Response:
             status_code=404,
         )
     try:
-        package = packaging.Package.from_path(archive)
-    except packaging.UnsupportedPackageType:
+        package = pypi_view.packaging.Package.from_path(archive)
+    except pypi_view.packaging.UnsupportedPackageType:
         return PlainTextResponse(
             PACKAGE_TYPE_NOT_SUPPORTED_ERROR,
             status_code=501,

pypi_view/packaging.py

@@ -3,11 +3,16 @@
 import contextlib
 import enum
 import os.path
+import re
 import typing
 import zipfile
 from dataclasses import dataclass
 
 
+def pep426_normalize(package_name: str) -> str:
+    return re.sub(r'[-_.]+', '-', package_name).lower()
+
+
 class UnsupportedPackageType(Exception):
     pass
 

pypi_view/pypi.py

@@ -32,6 +32,7 @@ async def files_for_package(package: str) -> typing.Dict[str, typing.Set[str]]:
     return {
         version: {file_['filename'] for file_ in files}
         for version, files in metadata['releases'].items()
+        if len(files) > 0
     }
 
 

pypi_view/static/site.css

@@ -1,2 +1,3 @@
-body {
+.page-package-file .metadata {
+    width: auto;
 }

pypi_view/templates/base.html renamed to pypi_view/templates/_base.html

@@ -29,7 +29,7 @@
             </div>
         </nav>
 
-        <div class="container">
+        <div class="container mt-4">
             {% block content %}{% endblock %}
         </div>
 

pypi_view/templates/_macros.html

@@ -0,0 +1,12 @@
+{% macro package_type_pill(filename) %}
+    {% if filename.endswith(".whl") %}
+        <span class="badge text-bg-success">Wheel</span>
+    {% elif filename.endswith(".egg") %}
+        <span class="badge text-bg-warning">Egg</span>
+    {% else %}
+        <span class="badge text-bg-secondary">Source distribution</span>
+    {% endif %}
+{% endmacro %}
+
+{# vim: ft=jinja
+#}

pypi_view/templates/home.html

@@ -1,5 +1,5 @@
 {% set page = 'home' %}
-{% extends 'base.html' %}
+{% extends '_base.html' %}
 
 {% block title %}PyPi View{% endblock %}
 

pypi_view/templates/package.html

@@ -1,19 +1,27 @@
 {% set page = 'package' %}
-{% extends 'base.html' %}
+{% extends '_base.html' %}
+{% import '_macros.html' as macros %}
 
 {% block title %}{{package}} | PyPi View{% endblock %}
 
 {% block content %}
     <h1>{{package}}</h1>
-    {% for version in version_to_files|sort %}
-        <h2>{{version}}</h2>
-        <ul>
-            {% for file in version_to_files[version]|sort %}
-                <li>
-                    <a href="{{url_for('package_file', package=package, filename=file)}}">{{file}}</a>
-                </li>
-            {% endfor %}
-        </ul>
+    <p>
+    <tt>{{package}}</tt> has {{version_to_files|length}} version{{version_to_files|length|pluralize}} and {{total_files}} file{{total_files|pluralize}}.
+        Select a file below to explore it.
+    </p>
+    {% for version, files in version_to_files %}
+        <div class="card bg-light mb-3">
+            <div class="card-header"><h5 class="mb-0">{{version}}</h5></div>
+            <div class="list-group list-group-flush">
+                {% for file in files|sort %}
+                    <a class="list-group-item list-group-item-action" href="{{url_for('package_file', package=package, filename=file)}}">
+                        <span class="font-monospace small">{{file}}</span>
+                        {{macros.package_type_pill(file)}}
+                    </a>
+                {% endfor %}
+            </div>
+        </div>
     {% endfor %}
 {% endblock %}
 

pypi_view/templates/package_file.html

@@ -1,42 +1,52 @@
 {% set page = 'package-file' %}
 {% set selected_package_name = package %}
-{% extends 'base.html' %}
+{% extends '_base.html' %}
+{% import '_macros.html' as macros %}
 
 {% block title %}{{filename}} | {{package}} | PyPi View{% endblock %}
 
 {% block content %}
-    <h1>{{filename}}</h1>
+    <h1><tt>{{filename}}</tt></h1>
+    <h5>{{macros.package_type_pill(filename)}}</h5>
 
     {% if metadata_path %}
-        <h2>Metadata</h2>
-        <table border="1">
+        <h4>Package Metadata</h4>
+        <table class="table table-bordered table-sm small metadata">
+            <caption>
+                Metadata parsed from
+                <a class="font-monospace" href="{{url_for('package_file_archive_path', package=package, filename=filename, archive_path=metadata_path)}}">
+                    {{metadata_path}}
+                </a>
+            </caption>
             {% for key, values in metadata.items()|sort %}
                 {% for value in values %}
                     <tr>
                         {% if loop.index == 1 %}
                             <th rowspan="{{values|length}}">{{key}}</th>
                         {% endif %}
-                        <td>{{value}}</td>
+                        <td class="font-monospace">{{value}}</td>
                     </tr>
                 {% endfor %}
             {% endfor %}
         </table>
-        <a href="{{url_for('package_file_archive_path', package=package, filename=filename, archive_path=metadata_path)}}">
-            View Raw Metadata
-        </a>
     {% endif %}
 
-    <h2>Files</h2>
-    <ul>
-        {% for entry in entries|sort(attribute="path") %}
-            <li>
+    <h4>Package Files</h4>
+    <div class="card bg-light mb-3">
+        <div class="list-group list-group-flush">
+            {% for entry in entries|sort(attribute="path") %}
                 <a
+                    class="list-group-item list-group-item-action small"
                     href="{{url_for('package_file_archive_path', package=package, filename=filename, archive_path=entry.path)}}"
-                >{{entry.path}}</a>
-                ({{entry.size}} bytes)
-            </li>
-        {% endfor %}
-    </ul>
+                >
+                    <span class="font-monospace">
+                        {{entry.path}}
+                    </span>
+                    {{entry.size|human_size}}
+                </a>
+            {% endfor %}
+        </div>
+    </div>
 {% endblock %}
 
 {# vim: ft=jinja

pypi_view/templates/package_file_archive_path.html

@@ -1,6 +1,6 @@
 {% set page = 'package-file-archive-path' %}
 {% set selected_package_name = package %}
-{% extends 'base.html' %}
+{% extends '_base.html' %}
 
 {% block title %}{{archive_path}} | {{filename}} | {{package}} | PyPi View{% endblock %}
 
@@ -19,7 +19,9 @@
 {% block content %}
     <h1>{{package}}: {{filename}}</h1>
     <h2>{{archive_path}}</h2>
-    {{rendered_text|safe}}
+    <div class="font-monospace">
+        {{rendered_text|safe}}
+    </div>
     <p><a href="?raw">View Raw</a></p>
 {% endblock %}