sphinx-javadoc-xml 0.3.0__tar.gz

sphinx_javadoc_xml-0.3.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 0.2.0 (2025-xx-xx)
+
+- Full support for interfaces as top-level type definitions
+- Type parameters with bounds (`<T extends Expression>`)
+- Bounded wildcards (`? extends X`, `? super Y`)
+- Exception declarations (`throws`)
+- Enum constant comments, tags, and annotations
+- Cross-linking to OpenJDK Javadoc for standard library types
+- Internal cross-references between defined types
+- New `javadoc-package` directive for package summaries
+- New `:jdk-url:` option to configure JDK Javadoc base URL
+- New `javadoc_jdk_url` config value in `conf.py`
+- Proper PyPI packaging with classifiers and metadata
+- Interface sections styled with green header
+
+## 0.1.0 (2025-xx-xx)
+
+- Initial release
+- Parse XML doclet output into structured data model
+- `javadoc-api` and `javadoc-class` directives
+- JavaDoc-inspired CSS with summary tables and detail blocks
+- `:public-only:` and `:package:` filter options
+- Package name stripping from type references

sphinx_javadoc_xml-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andreas Reichel / Manticore Projects
+
+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.

sphinx_javadoc_xml-0.3.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+include CHANGELOG.md
+recursive-include sphinx_javadoc_xml/static *.css

sphinx_javadoc_xml-0.3.0/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.4
+Name: sphinx-javadoc-xml
+Version: 0.3.0
+Summary: Sphinx extension to render Java API docs from XML doclet output, with OpenJDK cross-links
+Author-email: Andreas Reichel <andreas@manticore-projects.com>
+License: MIT
+Project-URL: Homepage, https://github.com/manticore-projects/sphinx-javadoc-xml
+Project-URL: Documentation, https://manticore-projects.com/sphinx-javadoc-xml/
+Project-URL: Repository, https://github.com/manticore-projects/sphinx-javadoc-xml
+Project-URL: Issues, https://github.com/manticore-projects/sphinx-javadoc-xml/issues
+Project-URL: Changelog, https://github.com/manticore-projects/sphinx-javadoc-xml/blob/main/CHANGELOG.md
+Keywords: sphinx,javadoc,java,api,documentation,xml,doclet
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+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: Topic :: Documentation
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sphinx>=5.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: sphinx-rtd-theme; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# sphinx-javadoc-xml
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-javadoc-xml)](https://pypi.org/project/sphinx-javadoc-xml/)
+[![Python](https://img.shields.io/pypi/pyversions/sphinx-javadoc-xml)](https://pypi.org/project/sphinx-javadoc-xml/)
+[![License](https://img.shields.io/pypi/l/sphinx-javadoc-xml)](LICENSE)
+
+A Sphinx extension that renders Java API documentation from an XML doclet output
+in a **JavaDoc-inspired style** — fully integrated with your Sphinx theme, with
+cross-links to [OpenJDK Javadoc](https://docs.oracle.com/en/java/javase/21/docs/api/)
+and between all defined types.
+
+## Features
+
+- **Full XML doclet support**: classes, interfaces, enums, methods, fields,
+  constructors, annotations, type parameters, bounded wildcards, exceptions
+- **OpenJDK cross-links**: `java.util.List` becomes a clickable link to the
+  Oracle JDK 21 docs (configurable URL)
+- **Internal cross-references**: all types defined in your API link to each other
+- **Package name stripping**: types within the same package show short names
+- **Three directives**: full API, single class, or package summary
+- **Theme-compatible CSS**: works with Furo, Read the Docs, Alabaster, and others
+
+## Installation
+
+```bash
+pip install sphinx-javadoc-xml
+```
+
+## Quick Start
+
+### 1. Enable in `conf.py`
+
+```python
+extensions = [
+    "sphinx_javadoc_xml",
+]
+
+# Optional configuration
+javadoc_jdk_url = "https://docs.oracle.com/en/java/javase/21/docs/api"
+javadoc_load_fonts = True    # Load Roboto fonts from Google Fonts CDN
+javadoc_load_bulma = False   # Load Bulma CSS from CDN (for non-Bulma themes)
+```
+
+### With manticore-sphinx-theme
+
+When using `manticore-sphinx-theme`, the extension automatically inherits the
+Manticore color scheme (`--bst-*` CSS variables), Roboto fonts, and Bulma CSS
+from the theme — no extra configuration needed:
+
+```python
+html_theme = "manticore_sphinx_theme"
+extensions = ["sphinx_javadoc_xml"]
+# Fonts and Bulma are auto-detected and skipped (already provided by theme)
+```
+
+### With other themes
+
+The extension ships with the Manticore color scheme as defaults and loads
+Google Fonts (Roboto family) automatically. Optionally enable Bulma for
+enhanced table rendering:
+
+```python
+html_theme = "furo"  # or alabaster, sphinx_rtd_theme, etc.
+extensions = ["sphinx_javadoc_xml"]
+javadoc_load_bulma = True  # Optional: pull Bulma from CDN
+```
+
+### 2. Place your XML file
+
+```
+docs/
+├── _static/
+│   └── api.xml
+├── conf.py
+└── api.rst
+```
+
+### 3. Use the directives
+
+**Full package API:**
+
+```rst
+.. javadoc-api:: _static/api.xml
+   :package: net.sf.jsqlparser.expression
+   :public-only:
+```
+
+**Single class:**
+
+```rst
+.. javadoc-class:: _static/api.xml
+   :class: net.sf.jsqlparser.expression.Function
+   :public-only:
+```
+
+**Package summary only (no type details):**
+
+```rst
+.. javadoc-package:: _static/api.xml
+   :package: net.sf.jsqlparser.statement.select
+   :public-only:
+```
+
+## Directives Reference
+
+### `.. javadoc-api:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:package:`    | Filter to a specific package name                |
+| `:public-only:`| Hide private and package-private members          |
+| `:jdk-url:`   | Override JDK Javadoc base URL for this directive  |
+
+### `.. javadoc-class:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:class:`      | **Required.** Qualified or simple class name     |
+| `:public-only:`| Hide private and package-private members          |
+| `:jdk-url:`   | Override JDK Javadoc base URL for this directive  |
+
+### `.. javadoc-package:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:package:`    | **Required.** Package name to render             |
+| `:public-only:`| Hide private and package-private members          |
+
+## Configuration (`conf.py`)
+
+| Option               | Default                                              | Description                                                                 |
+|----------------------|------------------------------------------------------|-----------------------------------------------------------------------------|
+| `javadoc_jdk_url`    | `https://docs.oracle.com/en/java/javase/21/docs/api` | Base URL for JDK Javadoc cross-links                                       |
+| `javadoc_load_fonts` | `True`                                               | Load Google Fonts (Roboto family); auto-disabled under manticore-sphinx-theme |
+| `javadoc_load_bulma` | `False`                                              | Load Bulma CSS from CDN; auto-disabled under manticore-sphinx-theme         |
+
+## Cross-Linking
+
+The extension automatically creates hyperlinks:
+
+- **JDK types** → Oracle Javadoc (e.g., `java.util.List` → [docs.oracle.com/...](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html))
+- **Internal types** → anchor links within the same page or document
+- External links open in a new tab and show a small ↗ indicator
+
+## Theme Compatibility
+
+The CSS uses CSS custom properties (`--jdx-*`) that automatically inherit
+from manticore-sphinx-theme's `--bst-*` variables when available:
+
+| Theme                    | Integration                                             |
+|--------------------------|---------------------------------------------------------|
+| **manticore-sphinx-theme** | Native — inherits colors, fonts, Bulma; zero config    |
+| **Furo**                   | Full — uses Manticore defaults, optional Bulma          |
+| **sphinx_rtd_theme**       | Full — Manticore colors with RTD layout                 |
+| **Alabaster**              | Full — clean integration                                |
+| **sphinx_book_theme**      | Full — Jupyter Book style with Manticore colors         |
+
+All CSS selectors are prefixed with `javadoc-` so they never conflict with
+theme styles.
+
+The extension expects the XML structure produced by the
+[xml-doclet](https://github.com/MarkusBernwordt/xml-doclet) or a compatible
+custom doclet. See the [CHANGELOG](CHANGELOG.md) for supported elements.
+
+## XML Format
+
+The extension expects the XML structure produced by the
+[xml-doclet](https://github.com/MarkusBernwordt/xml-doclet) or a compatible
+custom doclet. See the [CHANGELOG](CHANGELOG.md) for supported elements.
+
+## Publishing to PyPI
+
+```bash
+# Build
+python -m build
+
+# Upload to TestPyPI first
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+Or use GitHub Actions with [OIDC trusted publishing](https://docs.pypi.org/trusted-publishers/).
+
+## License
+
+[MIT](LICENSE)

sphinx_javadoc_xml-0.3.0/README.md

@@ -0,0 +1,188 @@
+# sphinx-javadoc-xml
+
+[![PyPI](https://img.shields.io/pypi/v/sphinx-javadoc-xml)](https://pypi.org/project/sphinx-javadoc-xml/)
+[![Python](https://img.shields.io/pypi/pyversions/sphinx-javadoc-xml)](https://pypi.org/project/sphinx-javadoc-xml/)
+[![License](https://img.shields.io/pypi/l/sphinx-javadoc-xml)](LICENSE)
+
+A Sphinx extension that renders Java API documentation from an XML doclet output
+in a **JavaDoc-inspired style** — fully integrated with your Sphinx theme, with
+cross-links to [OpenJDK Javadoc](https://docs.oracle.com/en/java/javase/21/docs/api/)
+and between all defined types.
+
+## Features
+
+- **Full XML doclet support**: classes, interfaces, enums, methods, fields,
+  constructors, annotations, type parameters, bounded wildcards, exceptions
+- **OpenJDK cross-links**: `java.util.List` becomes a clickable link to the
+  Oracle JDK 21 docs (configurable URL)
+- **Internal cross-references**: all types defined in your API link to each other
+- **Package name stripping**: types within the same package show short names
+- **Three directives**: full API, single class, or package summary
+- **Theme-compatible CSS**: works with Furo, Read the Docs, Alabaster, and others
+
+## Installation
+
+```bash
+pip install sphinx-javadoc-xml
+```
+
+## Quick Start
+
+### 1. Enable in `conf.py`
+
+```python
+extensions = [
+    "sphinx_javadoc_xml",
+]
+
+# Optional configuration
+javadoc_jdk_url = "https://docs.oracle.com/en/java/javase/21/docs/api"
+javadoc_load_fonts = True    # Load Roboto fonts from Google Fonts CDN
+javadoc_load_bulma = False   # Load Bulma CSS from CDN (for non-Bulma themes)
+```
+
+### With manticore-sphinx-theme
+
+When using `manticore-sphinx-theme`, the extension automatically inherits the
+Manticore color scheme (`--bst-*` CSS variables), Roboto fonts, and Bulma CSS
+from the theme — no extra configuration needed:
+
+```python
+html_theme = "manticore_sphinx_theme"
+extensions = ["sphinx_javadoc_xml"]
+# Fonts and Bulma are auto-detected and skipped (already provided by theme)
+```
+
+### With other themes
+
+The extension ships with the Manticore color scheme as defaults and loads
+Google Fonts (Roboto family) automatically. Optionally enable Bulma for
+enhanced table rendering:
+
+```python
+html_theme = "furo"  # or alabaster, sphinx_rtd_theme, etc.
+extensions = ["sphinx_javadoc_xml"]
+javadoc_load_bulma = True  # Optional: pull Bulma from CDN
+```
+
+### 2. Place your XML file
+
+```
+docs/
+├── _static/
+│   └── api.xml
+├── conf.py
+└── api.rst
+```
+
+### 3. Use the directives
+
+**Full package API:**
+
+```rst
+.. javadoc-api:: _static/api.xml
+   :package: net.sf.jsqlparser.expression
+   :public-only:
+```
+
+**Single class:**
+
+```rst
+.. javadoc-class:: _static/api.xml
+   :class: net.sf.jsqlparser.expression.Function
+   :public-only:
+```
+
+**Package summary only (no type details):**
+
+```rst
+.. javadoc-package:: _static/api.xml
+   :package: net.sf.jsqlparser.statement.select
+   :public-only:
+```
+
+## Directives Reference
+
+### `.. javadoc-api:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:package:`    | Filter to a specific package name                |
+| `:public-only:`| Hide private and package-private members          |
+| `:jdk-url:`   | Override JDK Javadoc base URL for this directive  |
+
+### `.. javadoc-class:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:class:`      | **Required.** Qualified or simple class name     |
+| `:public-only:`| Hide private and package-private members          |
+| `:jdk-url:`   | Override JDK Javadoc base URL for this directive  |
+
+### `.. javadoc-package:: <path>`
+
+| Option         | Description                                      |
+|----------------|--------------------------------------------------|
+| `:package:`    | **Required.** Package name to render             |
+| `:public-only:`| Hide private and package-private members          |
+
+## Configuration (`conf.py`)
+
+| Option               | Default                                              | Description                                                                 |
+|----------------------|------------------------------------------------------|-----------------------------------------------------------------------------|
+| `javadoc_jdk_url`    | `https://docs.oracle.com/en/java/javase/21/docs/api` | Base URL for JDK Javadoc cross-links                                       |
+| `javadoc_load_fonts` | `True`                                               | Load Google Fonts (Roboto family); auto-disabled under manticore-sphinx-theme |
+| `javadoc_load_bulma` | `False`                                              | Load Bulma CSS from CDN; auto-disabled under manticore-sphinx-theme         |
+
+## Cross-Linking
+
+The extension automatically creates hyperlinks:
+
+- **JDK types** → Oracle Javadoc (e.g., `java.util.List` → [docs.oracle.com/...](https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html))
+- **Internal types** → anchor links within the same page or document
+- External links open in a new tab and show a small ↗ indicator
+
+## Theme Compatibility
+
+The CSS uses CSS custom properties (`--jdx-*`) that automatically inherit
+from manticore-sphinx-theme's `--bst-*` variables when available:
+
+| Theme                    | Integration                                             |
+|--------------------------|---------------------------------------------------------|
+| **manticore-sphinx-theme** | Native — inherits colors, fonts, Bulma; zero config    |
+| **Furo**                   | Full — uses Manticore defaults, optional Bulma          |
+| **sphinx_rtd_theme**       | Full — Manticore colors with RTD layout                 |
+| **Alabaster**              | Full — clean integration                                |
+| **sphinx_book_theme**      | Full — Jupyter Book style with Manticore colors         |
+
+All CSS selectors are prefixed with `javadoc-` so they never conflict with
+theme styles.
+
+The extension expects the XML structure produced by the
+[xml-doclet](https://github.com/MarkusBernwordt/xml-doclet) or a compatible
+custom doclet. See the [CHANGELOG](CHANGELOG.md) for supported elements.
+
+## XML Format
+
+The extension expects the XML structure produced by the
+[xml-doclet](https://github.com/MarkusBernwordt/xml-doclet) or a compatible
+custom doclet. See the [CHANGELOG](CHANGELOG.md) for supported elements.
+
+## Publishing to PyPI
+
+```bash
+# Build
+python -m build
+
+# Upload to TestPyPI first
+twine upload --repository testpypi dist/*
+
+# Upload to PyPI
+twine upload dist/*
+```
+
+Or use GitHub Actions with [OIDC trusted publishing](https://docs.pypi.org/trusted-publishers/).
+
+## License
+
+[MIT](LICENSE)

sphinx_javadoc_xml-0.3.0/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sphinx-javadoc-xml"
+version = "0.3.0"
+description = "Sphinx extension to render Java API docs from XML doclet output, with OpenJDK cross-links"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Andreas Reichel", email = "andreas@manticore-projects.com"},
+]
+keywords = [
+    "sphinx",
+    "javadoc",
+    "java",
+    "api",
+    "documentation",
+    "xml",
+    "doclet",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Sphinx",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Documentation",
+    "Topic :: Documentation :: Sphinx",
+    "Topic :: Software Development :: Documentation",
+]
+dependencies = [
+    "sphinx>=5.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "sphinx-rtd-theme",
+    "furo",
+    "build",
+    "twine",
+]
+
+[project.urls]
+Homepage = "https://github.com/manticore-projects/sphinx-javadoc-xml"
+Documentation = "https://manticore-projects.com/sphinx-javadoc-xml/"
+Repository = "https://github.com/manticore-projects/sphinx-javadoc-xml"
+Issues = "https://github.com/manticore-projects/sphinx-javadoc-xml/issues"
+Changelog = "https://github.com/manticore-projects/sphinx-javadoc-xml/blob/main/CHANGELOG.md"
+
+[tool.setuptools.packages.find]
+include = ["sphinx_javadoc_xml"]
+
+[tool.setuptools.package-data]
+sphinx_javadoc_xml = ["static/*.css", "py.typed"]

sphinx_javadoc_xml-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sphinx_javadoc_xml-0.3.0/sphinx_javadoc_xml/__init__.py

@@ -0,0 +1,94 @@
+"""
+sphinx-javadoc-xml
+==================
+
+A Sphinx extension that renders Java API documentation from an XML doclet
+output in a JavaDoc-inspired style, with cross-links to OpenJDK Javadoc
+and internal type references.
+
+Directives
+----------
+
+``.. javadoc-api:: path/to/api.xml``
+    Renders the full API (all packages, types, members).
+    Options: ``:package:``, ``:public-only:``, ``:jdk-url:``
+
+``.. javadoc-class:: path/to/api.xml``
+    Renders a single type.
+    Options: ``:class:``, ``:public-only:``, ``:jdk-url:``
+
+``.. javadoc-package:: path/to/api.xml``
+    Renders a package summary table only.
+    Options: ``:package:``, ``:public-only:``
+"""
+
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+from typing import Any, Dict
+
+from sphinx.application import Sphinx
+
+from .directives import JavadocApiDirective, JavadocClassDirective, JavadocPackageDirective
+
+__version__ = "0.3.0"
+
+logger = logging.getLogger(__name__)
+
+# Google Fonts for Roboto family (Manticore branding)
+_GOOGLE_FONTS_URL = (
+    "https://fonts.googleapis.com/css2?"
+    "family=Roboto:wght@400;500;700"
+    "&family=Roboto+Slab:wght@400;500"
+    "&family=Roboto+Mono:wght@400;600"
+    "&display=swap"
+)
+
+_BULMA_CDN_URL = (
+    "https://cdn.jsdelivr.net/npm/[email protected]/css/bulma.min.css"
+)
+
+
+def _on_builder_inited(app: Sphinx) -> None:
+    """Register static files and optional CDN resources."""
+    logger.info("sphinx-javadoc-xml v%s loaded", __version__)
+
+    # Static dir for javadoc.css
+    static_dir = str(Path(__file__).parent / "static")
+    app.config.html_static_path.append(static_dir)
+
+    # Detect if running under manticore-sphinx-theme (which provides
+    # Roboto fonts and Bulma already)
+    theme = getattr(app.config, "html_theme", "")
+    is_manticore = theme in ("manticore_sphinx_theme", "manticore-sphinx-theme")
+
+    # Load Google Fonts unless the theme already provides them
+    if not is_manticore and app.config.javadoc_load_fonts:
+        app.add_css_file(_GOOGLE_FONTS_URL)
+
+    # Load Bulma CSS if requested and not already provided by theme
+    if not is_manticore and app.config.javadoc_load_bulma:
+        app.add_css_file(_BULMA_CDN_URL)
+
+
+def setup(app: Sphinx) -> Dict[str, Any]:
+    app.add_directive("javadoc-api", JavadocApiDirective)
+    app.add_directive("javadoc-class", JavadocClassDirective)
+    app.add_directive("javadoc-package", JavadocPackageDirective)
+
+    # Configuration values
+    app.add_config_value("javadoc_jdk_url",
+                         "https://docs.oracle.com/en/java/javase/21/docs/api",
+                         "html")
+    app.add_config_value("javadoc_load_fonts", True, "html")
+    app.add_config_value("javadoc_load_bulma", False, "html")
+
+    app.connect("builder-inited", _on_builder_inited)
+    app.add_css_file("javadoc.css")
+
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }