xml2rfc 3.26.0__py3-none-any.whl

xml2rfc/__init__.py

@@ -0,0 +1,68 @@
+# Copyright The IETF Trust 2011-2018, All Rights Reserved
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals, print_function, division
+
+# Static values
+__version__ = '3.26.0'
+NAME         = 'xml2rfc'
+VERSION      = [ int(i) if i.isdigit() else i for i in __version__.split('.') ]
+CACHES       = ['/var/cache/xml2rfc', '~/.cache/xml2rfc']  # Ordered by priority
+CACHE_PREFIX = ''
+NET_SUBDIRS  = ['bibxml', 'bibxml-misc', 'bibxml-ids', 'bibxml-w3c', 'bibxml-3gpp', 'bibxml-ieee', 'bibxml-rfcsubseries']
+V3_PI_TARGET = 'v3xml2rfc'
+
+from xml2rfc.parser import  XmlRfcError, CachingResolver, XmlRfcParser, XmlRfc
+
+from xml2rfc.writers import ( BaseRfcWriter, RawTextRfcWriter, PaginatedTextRfcWriter,
+	 HtmlRfcWriter, NroffRfcWriter, ExpandedXmlWriter, RfcWriterError,
+         V2v3XmlWriter, PrepToolWriter, TextWriter, HtmlWriter, PdfWriter,
+         ExpandV3XmlWriter, UnPrepWriter, DocWriter, DatatrackerToBibConverter,
+     )
+
+# This defines what 'from xml2rfc import *' actually imports:
+__all__ = ['XmlRfcError', 'CachingResolver', 'XmlRfcParser', 'XmlRfc',
+           'BaseRfcWriter', 'RawTextRfcWriter', 'PaginatedTextRfcWriter',
+           'HtmlRfcWriter', 'NroffRfcWriter', 'ExpandedXmlWriter',
+           'RfcWriterError', 'V2v3XmlWriter', 'PrepToolWriter', 'TextWriter',
+           'HtmlWriter', 'PdfWriter', 'ExpandV3XmlWriter', 'UnPrepWriter', 
+           'DocWriter', 'DatatrackerToBibConverter',
+       ]
+
+try:
+    import weasyprint
+    HAVE_WEASYPRINT = True
+except (ImportError, OSError, ValueError):
+    weasyprint = False
+    HAVE_WEASYPRINT = False
+try:
+    from weasyprint.text.ffi import pango
+    HAVE_PANGO = True
+    PANGO_VERSION = pango.pango_version
+except (ImportError, OSError, AttributeError):
+    HAVE_PANGO = False
+    PANGO_VERSION = None
+
+
+def get_versions():
+    import sys
+    versions = []
+    try:
+        from importlib import metadata
+        from re import split
+        this = metadata.distribution(NAME)
+        for p in [split(r'[\s=<>!]', x)[0] for x in this.requires]:
+            try:
+                dist = metadata.distribution(p)
+                versions.append((dist.metadata['name'], dist.metadata['version']))
+            except:
+                pass
+    except:
+        pass
+
+    versions.sort(key=lambda x: x[0].lower())
+    versions = [
+            (NAME, __version__),
+            ('Python', sys.version.split()[0]),
+        ] + versions
+
+    return versions

xml2rfc/boilerplate_id_guidelines.py

@@ -0,0 +1,28 @@
+# Copyright The IETF Trust 2017, All Rights Reserved
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals, print_function
+
+# The following text entries were taken from
+# https://www.ietf.org/ietf-ftp/1id-guidelines.txt
+
+boilerplate_draft_status_of_memo = [
+        """<t>
+        This Internet-Draft is submitted in full conformance with the
+        provisions of BCP 78 and BCP 79.
+        </t>""",
+        """<t>
+        Internet-Drafts are working documents of the Internet Engineering Task
+        Force (IETF). Note that other groups may also distribute working
+        documents as Internet-Drafts. The list of current Internet-Drafts is
+        at <eref target="{scheme}://datatracker.ietf.org/drafts/current/"/>.
+        </t>""",
+        """<t>
+        Internet-Drafts are draft documents valid for a maximum of six months
+        and may be updated, replaced, or obsoleted by other documents at any
+        time. It is inappropriate to use Internet-Drafts as reference
+        material or to cite them other than as "work in progress."
+        </t>""",
+        """<t>
+        This Internet-Draft will expire on {expiration_date}.
+        </t>""",
+    ]

xml2rfc/boilerplate_rfc_7841.py

@@ -0,0 +1,575 @@
+# Copyright The IETF Trust 2017,2021 All Rights Reserved
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals, print_function
+
+# The following text entries, derived from RFC 7841, were taken from
+# https://www.rfc-editor.org/materials/status-memos.txt on 01 Feb 2018
+# and updated to match https://www.iab.org/documents/headers-boilerplate/
+
+boilerplate_rfc_status_of_memo = {
+    'IETF': {
+        'std': {
+            'true' : ["""<t>
+            This is an Internet Standards Track document.
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Engineering Task Force
+            (IETF).  It represents the consensus of the IETF community.  It has
+            received public review and has been approved for publication by
+            the Internet Engineering Steering Group (IESG).  Further
+            information on Internet Standards is available in Section 2 of 
+            RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'bcp': {
+            'true' : [ """<t>
+            This memo documents an Internet Best Current Practice.
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Engineering Task Force
+            (IETF).  It represents the consensus of the IETF community.  It has
+            received public review and has been approved for publication by
+            the Internet Engineering Steering Group (IESG).  Further information
+            on BCPs is available in Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'exp': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation.
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This document is a product of the Internet Engineering
+            Task Force (IETF).  It represents the consensus of the IETF community.
+            It has received public review and has been approved for publication
+            by the Internet Engineering Steering Group (IESG).  Not all documents
+            approved by the IESG are candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841. 
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation.
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This document is a product of the Internet Engineering
+            Task Force (IETF).  It has been approved for publication by the
+            Internet Engineering Steering Group (IESG).  Not all documents
+            approved by the IESG are candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841. 
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'historic': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Engineering
+            Task Force (IETF).  It represents the consensus of the IETF community.
+            It has received public review and has been approved for publication by
+            the Internet Engineering Steering Group (IESG).  Not all documents
+            approved by the IESG are candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841. 
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Engineering Task Force
+            (IETF).  It has been approved for publication by the Internet
+            Engineering Steering Group (IESG).  Not all documents approved by the
+            IESG are candidates for any level of Internet Standard; see Section 2
+            of RFC 7841. 
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'info': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.  
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Engineering Task Force
+            (IETF).  It represents the consensus of the IETF community.  It has
+            received public review and has been approved for publication by the
+            Internet Engineering Steering Group (IESG).  Not all documents
+            approved by the IESG are candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841. 
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.  
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Engineering Task Force
+            (IETF).  It has been approved for publication by the Internet
+            Engineering Steering Group (IESG).  Not all documents approved by the
+            IESG are candidates for any level of Internet Standard; see Section 2
+            of RFC 7841.   
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+    },
+    'IAB': {
+        'historic': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Architecture
+            Board (IAB) and represents information that the IAB has deemed
+            valuable to provide for permanent record.  It represents the consensus of the
+            Internet Architecture Board (IAB).  Documents approved for
+            publication by the IAB are not candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Architecture
+            Board (IAB) and represents information that the IAB has deemed
+            valuable to provide for permanent record.  Documents approved for
+            publication by the IAB are not candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'info': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.  
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Architecture Board
+            (IAB) and represents information that the IAB has deemed valuable
+            to provide for permanent record.  It represents the consensus of the Internet
+            Architecture Board (IAB).  Documents approved for publication
+            by the IAB are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Architecture Board
+            (IAB) and represents information that the IAB has deemed valuable
+            to provide for permanent record.  Documents approved for publication
+            by the IAB are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+    },
+    'IRTF': {
+        'exp': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation. 
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This document is a product of the Internet Research
+            Task Force (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the consensus of the
+            {group_name} Research Group of the Internet Research Task Force
+            (IRTF).  Documents approved for publication by the IRSG are not
+            candidates for any level of Internet Standard; see Section 2 of RFC
+            7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation.
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This document is a product of the Internet Research Task
+            Force (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the individual
+            opinion(s) of one or more members of the {group_name} Research Group
+            of the Internet Research Task Force (IRTF).  Documents approved for
+            publication by the IRSG are not candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'n/a': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation.
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This document is a product of the Internet Research
+            Task Force (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  Documents approved for publication by the
+            IRSG are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'historic': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Research Task Force
+            (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the consensus of
+            the {group_name} Research Group of the Internet Research Task Force (IRTF).
+            Documents approved for publication by the IRSG are not candidates for
+            any level of Internet Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet community.
+            This document is a product of the Internet Research Task Force
+            (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the individual opinion(s) of one or more
+            members of the {group_name} Research Group of the Internet
+            Research Task Force (IRTF).  Documents approved for
+            publication by the IRSG are not candidates for
+            any level of Internet Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'n/a': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This document is a product of the Internet Research
+            Task Force (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  Documents approved for publication by the
+            IRSG are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+        'info': {
+            'true' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.  
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Research Task Force
+            (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the consensus of the {group_name}
+            Research Group of the Internet Research Task Force (IRTF).
+            Documents approved for publication by the IRSG are not
+            candidates for any level of Internet Standard; see Section 2 of RFC
+            7841.   
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.  
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Research Task Force
+            (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  This RFC represents the individual opinion(s) of one or more
+            members of the {group_name} Research Group of the Internet
+            Research Task Force (IRTF).  Documents approved for publication by the IRSG are not
+            candidates for any level of Internet Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'n/a': [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.
+            </t>""",
+
+            """<t>
+            This document is a product of the Internet Research Task Force
+            (IRTF).  The IRTF publishes the results of Internet-related
+            research and development activities.  These results might not be
+            suitable for deployment.  Documents approved for publication by the
+            IRSG are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+    },
+    'independent': {
+        'exp': {
+            'n/a' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for examination, experimental implementation, and
+            evaluation.
+            </t>""",
+
+            """<t>
+            This document defines an Experimental Protocol for the Internet
+            community.  This is a contribution to the RFC Series,
+            independently of any other RFC stream.  The RFC Editor has chosen to publish this
+            document at its discretion and makes no statement about its value
+            for implementation or deployment.  Documents approved for publication
+            by the RFC Editor are not candidates for any level of Internet
+            Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            </t>""",
+            ],
+        },
+        'historic': {
+            'n/a' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for the historical record.
+            </t>""",
+
+            """<t>
+            This document defines a Historic Document for the Internet
+            community.  This is a contribution to the RFC Series, independently of any
+            other RFC stream.  The RFC Editor has chosen to publish this
+            document at its discretion and makes no statement about its value
+            for implementation or deployment.  Documents approved for
+            publication by the RFC Editor are not candidates for any level of
+            Internet Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+            'false': [ """<t>
+            </t>""",
+            ],
+        },
+        'info': {
+            'n/a' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.
+            </t>""",
+
+            """<t>
+            This is a contribution to the RFC Series, independently of any
+            other RFC stream.  The RFC Editor has chosen to publish this
+            document at its discretion and makes no statement about its value
+            for implementation or deployment.  Documents approved for
+            publication by the RFC Editor are not candidates for any level of
+            Internet Standard; see Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any
+            errata, and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+    },
+    'editorial': {
+        'info': {
+            'n/a' : [ """<t>
+            This document is not an Internet Standards Track specification; it is
+            published for informational purposes.
+            </t>""",
+
+            """<t>
+            This document is a product of the RFC Series Policy Definition
+            Process.  It represents the consensus of the RFC Series Working
+            Group approved by the RFC Series Approval Board.  Such documents
+            are not candidates for any level of Internet Standard; see
+            Section 2 of RFC 7841.
+            </t>""",
+
+            """<t>
+            Information about the current status of this document, any errata,
+            and how to provide feedback on it may be obtained at
+            <eref target="{scheme}://www.rfc-editor.org/info/rfc{rfc_number}" />.
+            </t>""",
+            ],
+        },
+    },
+}