flask-admin-autolinks 0.1.0__py3-none-any.whl

flask_admin_autolinks/__init__.py

@@ -0,0 +1,3 @@
+from .mixin import AutoLinksMixin
+
+__all__ = ["AutoLinksMixin"]

flask_admin_autolinks/mixin.py

@@ -0,0 +1,69 @@
+"""Hyperlink relationship columns in Flask-Admin SQLAlchemy list views."""
+
+import typing as t
+
+from flask import url_for
+from flask_admin.contrib.sqla.tools import is_relationship
+from markupsafe import Markup, escape
+
+
+class AutoLinksMixin:
+    """Put before ModelView in the bases. True = auto-detect; dict = per-column endpoint override."""
+
+    column_relationship_links: bool | dict[str, str] = False
+
+    def __init__(self, *args: t.Any, **kwargs: t.Any) -> None:
+        super().__init__(*args, **kwargs)
+        self._autolinks = self._scaffold_autolinks()
+        if self._autolinks:  # eager-load link targets: no N+1 on the list page
+            self._auto_joins = list({*self._auto_joins, *self._autolinks.values()})
+
+    def _scaffold_autolinks(self) -> dict[str, t.Any]:
+        if not self.column_relationship_links:
+            return {}
+        found = {}
+        for name, _label in self._list_columns:
+            if name in self.column_formatters:  # explicit formatters always win
+                continue
+            attr = getattr(self.model, name, None)
+            if attr is not None and is_relationship(attr):
+                found[name] = attr
+        return found
+
+    def _target_view(self, name: str, related_cls: type) -> t.Any:
+        links = self.column_relationship_links
+        endpoint = links.get(name) if isinstance(links, dict) else None
+        for view in self.admin._views:
+            if endpoint is not None:
+                if view.endpoint == endpoint:
+                    return view
+            elif getattr(view, "model", None) is related_cls:
+                return view
+        return None
+
+    @staticmethod
+    def _href(view: t.Any, target: t.Any) -> str | None:
+        if view is None or not view.is_accessible():
+            return None
+        pk = view.get_pk_value(target)
+        if view.can_edit:
+            return url_for(f"{view.endpoint}.edit_view", id=pk)
+        if view.can_view_details:
+            return url_for(f"{view.endpoint}.details_view", id=pk)
+        return None
+
+    def get_list_value(self, context: t.Any, model: t.Any, name: str) -> t.Any:
+        attr = self._autolinks.get(name)
+        if attr is None:
+            return super().get_list_value(context, model, name)
+        value = getattr(model, name)
+        if value is None:
+            return ""
+        prop = attr.property
+        view = self._target_view(name, prop.mapper.class_)
+        out = []
+        for target in value if prop.uselist else [value]:
+            label = escape(str(target))
+            href = self._href(view, target)
+            out.append(Markup('<a href="{}">{}</a>').format(href, label) if href else label)
+        return Markup(", ").join(out)

flask_admin_autolinks-0.1.0.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.5
+Name: flask-admin-autolinks
+Version: 0.1.0
+Summary: Implements autolinks for related models in ModelView from Flask-Admin
+Author-email: Mario Hernandez <mariofix@proton.me>
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: flask-admin>=2.2.1
+Description-Content-Type: text/markdown
+
+# flask-admin-autolinks
+
+Automatic hyperlinks for relationship columns in Flask-Admin's SQLAlchemy list views.
+
+By default, a relationship column renders as plain text (`str()` of the related object). With this mixin, each related object becomes a link to its own edit (or details) page in the admin.
+
+## Features
+
+- Opt-in per view. No effect unless `column_relationship_links` is set.
+- Resolves the target view from the registered views by model. No endpoint naming convention required.
+- Respects the target view's `can_edit`, `can_view_details` and `is_accessible()`. Falls back to plain text.
+- Eager-loads link targets through the view's `_auto_joins`, so the list page does not issue N+1 queries.
+- Explicit `column_formatters` entries always win.
+- Output is escaped.
+
+## Installation
+
+```bash
+uv add flask-admin-autolinks
+# or
+pip install flask-admin-autolinks
+```
+
+Requires Flask-Admin with SQLAlchemy support (`flask-admin[sqlalchemy]`). Supported versions are declared in `pyproject.toml`.
+
+## Usage
+
+Place `AutoLinksMixin` before `ModelView` in the bases:
+
+```python
+from flask_admin.contrib.sqla import ModelView
+from flask_admin_autolinks import AutoLinksMixin
+
+
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = True
+```
+
+For project-wide use, define a shared base once:
+
+```python
+class BaseView(AutoLinksMixin, ModelView):
+    column_relationship_links = True
+```
+
+Only relationship columns listed in `column_list` are linked.
+
+## Configuration
+
+`column_relationship_links` accepts:
+
+| Value | Behavior |
+| --- | --- |
+| `False` (default) | Disabled. |
+| `True` | Link every relationship column in `column_list` to the registered view for the related model. |
+| `dict[str, str]` | Same as `True`, with per-column overrides mapping a relationship name to a view endpoint. |
+
+```python
+class OrderView(AutoLinksMixin, ModelView):
+    column_list = ("id", "customer", "items")
+    column_relationship_links = {"customer": "client"}  # "client" is the target view's endpoint
+```
+
+An empty dict is falsy and leaves the feature disabled.
+
+## Behavior
+
+For each related object, the link target is chosen in this order:
+
+1. Target view has `can_edit` and is accessible: link to `edit_view`.
+2. Otherwise, target view has `can_view_details` and is accessible: link to `details_view`.
+3. Otherwise: escaped plain text.
+
+If no view is registered for the related model (or the override endpoint is not found), the cell renders as plain text. The list page is never broken by a missing target.
+
+Collections render as comma-separated links. `None` renders as an empty cell.
+
+A column that already has an entry in `column_formatters` is left untouched and is not eager-loaded by this package.
+
+## To Do
+
+- SQLAlchemy backend only (`flask_admin.contrib.sqla`), add others.
+
+## License
+
+See `LICENSE` for MIT License.
+
+## IA
+
+Documentation done with Claude.

flask_admin_autolinks-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+flask_admin_autolinks/__init__.py,sha256=8efM6HJ6nyXm4eCv12_6dHMAImwaT2ye1BJ2aRPjLhw,64
+flask_admin_autolinks/mixin.py,sha256=vCEizpf3hZhD5a4lfNPcltal333r-x0XSL9x9p88flM,2722
+flask_admin_autolinks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flask_admin_autolinks-0.1.0.dist-info/METADATA,sha256=jsWeOUntAVr5OEQnicZARGmhbKz8DQrr7oRQ_4AIlM4,3248
+flask_admin_autolinks-0.1.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+flask_admin_autolinks-0.1.0.dist-info/licenses/LICENSE,sha256=_McTnrwzSZTy3mRFU9bF65PXsF9zLOPbJbKWetXuR7M,1072
+flask_admin_autolinks-0.1.0.dist-info/RECORD,,

flask_admin_autolinks-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

flask_admin_autolinks-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mario Hernandez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.