amoeba commented on code in PR #2890: URL: https://github.com/apache/arrow-adbc/pull/2890#discussion_r2178290816
########## docs/source/ext/adbc_misc.py: ########## @@ -0,0 +1,238 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +"""Misc directives for the ADBC docs.""" + +import dataclasses +import functools +import itertools +import typing +from pathlib import Path + +import docutils +from docutils.statemachine import StringList +from sphinx.util.docutils import SphinxDirective +from sphinx.util.nodes import nested_parse_with_titles +from sphinx.util.typing import OptionSpec + + [email protected](frozen=True) +class DriverStatus: + vendor: str + implementation: str + status: typing.Literal["Experimental", "Beta", "Stable"] + packages: typing.List[typing.Tuple[str, str, str]] # (repo, package, URL) + + @property + def badge_type(self) -> str: + if self.status == "Experimental": + return "danger" + elif self.status == "Beta": + return "warning" + elif self.status == "Stable": + return "success" + else: + raise ValueError(f"Unknown status {self.status} for {self.implementation}") + + [email protected] +def _driver_status(path: Path) -> DriverStatus: + # we could pull in a full markdown parser, but for now just munge the text + meta: typing.Dict[str, str] = {} + packages = [] + with path.open() as source: + for line in source: + if "img.shields.io" in line: + before, _, after = line.partition("img.shields.io") + tag = before[before.index("![") + 2 : before.index("]")].strip() + key, _, value = tag.partition(": ") + key = key.strip().lower() + value = value.strip() + + if key in {"vendor", "implementation", "status"}: + meta[key] = value + else: + repo = key + url = after[after.rfind("(") + 1 : after.rfind(")")].strip() + packages.append((repo, value, url)) + return DriverStatus(**meta, packages=packages) + + +def driver_status(path: Path) -> DriverStatus: + return _driver_status(path.resolve()) + + +class DriverStatusDirective(SphinxDirective): + has_content = False + required_arguments = 1 + optional_arguments = 0 + option_spec: OptionSpec = {} + + def run(self): + rel_filename, filename = self.env.relfn2path(self.arguments[0]) + self.env.note_dependency(rel_filename) + + path = Path(filename).resolve() + status = driver_status(path) + + generated_lines = [ + f":bdg-primary:`{status.implementation}`" + f":bdg-{status.badge_type}:`{status.status}`" + ] + + if status.packages: + generated_lines.append("") + generated_lines.append("Available from:") + for repo, package, url in status.packages: + generated_lines.append( + f":bdg-link-secondary:`{repo} ({package}) <{url}>`" + ) + + if status.implementation in {"C/C++", "C#", "Go", "Rust"}: + if not status.packages: + generated_lines.append("") + generated_lines.append( + "May be used from C/C++, C#, GLib, Go, R, " + "Ruby, and Rust via the driver manager." + ) + + parsed = docutils.nodes.Element() + nested_parse_with_titles( + self.state, + StringList(generated_lines, source=""), + parsed, + ) + return parsed.children + + +class DriverStatusTableDirective(SphinxDirective): + has_content = True + required_arguments = 0 + optional_arguments = 0 + option_spec: OptionSpec = {} + + def run(self): + table = [] + for line in self.content: + if "=>" in line: + xref, _, path = line.partition("=>") + xref = xref.strip() + path = path.strip() + else: + xref = None + path = line.strip() + + if "[#" in path: + footnote = path[path.index("[#") + 2 : -1].strip() + path = path[: path.index("[#")].strip() + else: + footnote = None + + rel_filename, filename = self.env.relfn2path(path) + self.env.note_dependency(rel_filename) + + path = Path(filename).resolve() + status = driver_status(path) + table.append((status, xref, footnote)) + + table.sort(key=lambda x: (x[0].vendor, x[0].implementation)) + + generated_lines = [ + ".. list-table::", + " :header-rows: 1", + "", + " * - Vendor", + " - Implementation", + " - Driver Status", + " - Packages [#packages]_", + "", + ] + for row in table: + if row[1]: + generated_lines.append(f" * - :doc:`{row[0].vendor} <{row[1]}>`") + else: + generated_lines.append(f" * - {row[0].vendor}") + + if row[2]: + generated_lines[-1] += f" [#{row[2]}]_" + + generated_lines.append(f" - {row[0].implementation}") + badge_type = row[0].badge_type + generated_lines.append(f" - :bdg-{badge_type}:`{row[0].status}`") Review Comment: ```suggestion generated_lines.append(f" - {row[0].status}") ``` The visual weight this has in the table is relatively high. I think badges on the individual driver README pages is fine but I wonder if we can retain the plain-text formatting of the statuses in this table? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
