Merge pull request #688 from tefra/dtd

Implement DTD code generator
tefra · Jul 9, 2022 · 7eede8e · 7eede8e
2 parents fa9f014 + 9578ad3
commit 7eede8e
Show file tree

Hide file tree

Showing 27 changed files with 1,248 additions and 24 deletions.
diff --git a/.bandit b/.bandit
@@ -1,3 +1,3 @@
 [bandit]
 exclude: tests/,docs/
-skips: B701
+skips: B701,B410
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -2,16 +2,16 @@ exclude: tests/fixtures
 
 repos:
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.32.1
+    rev: v2.34.0
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.1.0
+    rev: v3.3.0
     hooks:
       - id: reorder-python-imports
   - repo: https://github.com/ambv/black
-    rev: 22.3.0
+    rev: 22.6.0
     hooks:
       - id: black
   - repo: https://gitlab.com/pycqa/flake8
@@ -26,7 +26,7 @@ repos:
         args: ["--suppress-none-returning"]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
+    rev: v4.3.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -37,7 +37,7 @@ repos:
       - id: docformatter
         args: ["--in-place", "--pre-summary-newline"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.950
+    rev: v0.961
     hooks:
       - id: mypy
         additional_dependencies: [tokenize-rt, types-requests, types-Jinja2, types-click, types-docutils]
@@ -47,6 +47,6 @@ repos:
       - id: setup-cfg-fmt
         args: ["--max-py-version=3.11"]
   - repo: https://github.com/PyCQA/doc8
-    rev: 0.11.1
+    rev: 0.11.2
     hooks:
       - id: doc8
diff --git a/README.rst b/README.rst
@@ -30,7 +30,7 @@ Naive XML Bindings for python
 xsData is a complete data binding library for python allowing developers to access and
 use XML and JSON documents as simple objects rather than using DOM.
 
-It ships with a code generator for XML schemas, WSDL definitions, XML & JSON documents.
+The code generator supports XML schemas, DTD, WSDL definitions, XML & JSON documents.
 It produces simple dataclasses with type hints and simple binding metadata.
 
 The included XML and JSON parser/serializer are highly optimized and adaptable, with
@@ -76,6 +76,7 @@ Features
 
   - XML Schemas 1.0 & 1.1
   - WSDL 1.1 definitions with SOAP 1.1 bindings
+  - DTD external definitions
   - Directly from XML and JSON Documents
   - Extensive configuration to customize output
   - Pluggable code writer for custom output formats

diff --git a/docs/codegen.rst b/docs/codegen.rst
@@ -27,7 +27,7 @@ Generate Code
 
 
 .. code-block:: console
-    :caption: Scan directory for xsd, wsdl, xml files
+    :caption: Scan directory for xsd, dtd, wsdl, xml or json files
 
     $ xsdata amadeus/schemas --package amadeus.models
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -11,6 +11,7 @@ Code Generation
     examples/docstrings
     examples/xml-modeling
     examples/json-modeling
+    examples/dtd-modeling
     examples/compound-fields
     examples/dataclasses-features
 

diff --git a/docs/examples/dtd-modeling.rst b/docs/examples/dtd-modeling.rst
@@ -0,0 +1,20 @@
+============
+DTD Modeling
+============
+
+The code generator supports processing external document type definitions (DTD).
+
+.. code-block:: console
+
+    $ xsdata --package tests.fixtures.dtd.models tests/fixtures/dtd/complete_example.dtd
+
+
+.. tab:: DTD Definition
+
+    .. literalinclude:: /../tests/fixtures/dtd/complete_example.dtd
+       :language: dtd
+
+.. tab:: Output
+
+    .. literalinclude:: /../tests/fixtures/dtd/models/complete_example.py
+       :language: python
diff --git a/docs/faq/error-parsing-dtd.rst b/docs/faq/error-parsing-dtd.rst
@@ -0,0 +1,9 @@
+DTDParseError: error parsing DTD
+================================
+
+xsdata works only with **external** document type definitions
+and relies on `lxml <https://lxml.de/>`_ exclusively to parse
+the dtd tree.
+
+Try to remove the `DOCTYPE` wrapper if you are sure the rest of
+the definition is correct.