xmllayout2 2.0.0__tar.gz

xmllayout2-2.0.0/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

xmllayout2-2.0.0/.gitignore

@@ -0,0 +1,103 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear on external disk
+.Spotlight-V100
+.Trashes
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+# =========================
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+venv/

xmllayout2-2.0.0/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014: Philip Jenvey, 2020-2025: Jonas Lindner
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

xmllayout2-2.0.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.2
+Name: xmllayout2
+Version: 2.0.0
+Summary: Formats Python log messages as log4j XMLLayout XML
+Home-page: http://pypi.python.org/pypi/XMLLayout
+Author: Jonas Lindner
+Author-email: jonaslindner55@gmail.com
+License: BSD
+Keywords: logging log4j
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Topic :: System :: Logging
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=6.2.2; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: summary
+
+XMLLayout2 provides a Python logging Formatter that formats log messages as XML,
+according to `log4j's [XMLLayout specification](https://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html)
+
+XMLLayout formatted log messages can be viewed and filtered within the
+[Chainsaw](https://logging.apache.org/chainsaw/2.x) application
+(see the example section below), part of the Java based log4j project.
+
+This package also includes a RawSocketHandler -- like
+logging.handler.SocketHandler, but sends the raw log message over the socket
+instead of a pickled version. RawSocketHandler can be configured to send log
+messages to Chainsaw directly over a socket.
+
+For example: to forward log messages to Chainsaw, if it were listening on
+localhost port 4448::
+
+    import logging
+    import xmllayout2
+
+    handler = xmllayout2.RawSocketHandler('localhost', 4448)
+    handler.setFormatter(xmllayout2.XMLLayout())
+    logging.root.addHandler(handler)
+
+This is a fork of Philip Jenveys original package xmllayout. Maintained for usage in commercial projects, with supporting a variety of Python versions.
+
+Installation via pip:
+pip install xmllayout2

xmllayout2-2.0.0/README.md

@@ -0,0 +1,26 @@
+XMLLayout2 provides a Python logging Formatter that formats log messages as XML,
+according to `log4j's [XMLLayout specification](https://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html)
+
+XMLLayout formatted log messages can be viewed and filtered within the
+[Chainsaw](https://logging.apache.org/chainsaw/2.x) application
+(see the example section below), part of the Java based log4j project.
+
+This package also includes a RawSocketHandler -- like
+logging.handler.SocketHandler, but sends the raw log message over the socket
+instead of a pickled version. RawSocketHandler can be configured to send log
+messages to Chainsaw directly over a socket.
+
+For example: to forward log messages to Chainsaw, if it were listening on
+localhost port 4448::
+
+    import logging
+    import xmllayout2
+
+    handler = xmllayout2.RawSocketHandler('localhost', 4448)
+    handler.setFormatter(xmllayout2.XMLLayout())
+    logging.root.addHandler(handler)
+
+This is a fork of Philip Jenveys original package xmllayout. Maintained for usage in commercial projects, with supporting a variety of Python versions.
+
+Installation via pip:
+pip install xmllayout2

xmllayout2-2.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"

xmllayout2-2.0.0/setup.cfg

@@ -0,0 +1,29 @@
+[metadata]
+name = "xmllayout2"
+description = "Formats Python log messages as log4j XMLLayout XML"
+version = "2.0.0"
+author = Jonas Lindner
+author_email = "jonaslindner55@gmail.com"
+keywords = ['logging', 'log4j']
+license = BSD 2-clause
+license_file = LICENSE
+long_description_content_type = text/markdown; charset=UTF-8
+classifiers = 
+	'Development Status :: 5 - Production/Stable',
+	'Intended Audience :: Developers',
+	'License :: OSI Approved :: BSD License',
+	'Programming Language :: Python',
+	'Programming Language :: Python :: 3',
+	'Programming Language :: Python :: Implementation :: CPython',
+	'Programming Language :: Python :: Implementation :: PyPy',
+	'Programming Language :: Python :: Implementation :: Jython',
+	'Topic :: System :: Logging'
+
+[options.extras_require]
+test = 
+	pytest >= 6.2.2
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

xmllayout2-2.0.0/setup.py

@@ -0,0 +1,43 @@
+from os import path
+from setuptools import setup, find_packages
+import io
+
+version = '2.0.0'
+
+# Just here for Python2
+# compatibility
+# If not needed:
+# import setuptools
+# if __name__ == "__main__":
+# setuptools.setup()
+
+here = path.abspath(path.dirname(__file__))
+with io.open(path.join(here, 'README.md')) as f:
+    long_description = f.read()
+
+setup(
+	name='xmllayout2',
+    version=version,
+    description="Formats Python log messages as log4j XMLLayout XML",
+    long_description=long_description,
+    classifiers=[
+		'Development Status :: 5 - Production/Stable',
+		'Intended Audience :: Developers',
+		'License :: OSI Approved :: BSD License',
+		'Programming Language :: Python',
+		'Programming Language :: Python :: 3',
+		'Programming Language :: Python :: Implementation :: CPython',
+		'Programming Language :: Python :: Implementation :: PyPy',
+		'Programming Language :: Python :: Implementation :: Jython',
+		'Topic :: System :: Logging'
+    ],
+    keywords='logging log4j',
+    author='Jonas Lindner',
+    author_email='jonaslindner55@gmail.com',
+    url='http://pypi.python.org/pypi/XMLLayout',
+    license='BSD',
+    packages=find_packages(),
+    include_package_data=True,
+    zip_safe=False,
+    tests_require=['pytest'],
+)

xmllayout2-2.0.0/xmllayout2/formatters.py

@@ -0,0 +1,96 @@
+"""logging Formatters"""
+try:
+    from cgi import escape  # < Python3.7
+except ImportError:
+    from html import escape
+import logging
+
+__all__ = ['XMLLayout']
+
+# Level names differ slightly in log4j, see
+# http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html
+LOG4J_LEVELS = dict(WARNING='WARN', CRITICAL='FATAL')
+
+
+class XMLLayout(logging.Formatter):
+
+    """Formats log Records as XML according to the `log4j XMLLayout
+    <http://logging.apache.org/log4j/docs/api/org/apache/log4j/xml/
+    XMLLayout.html>_`
+    """
+
+    def format(self, record):
+        """Format the log record as XMLLayout XML"""
+        levelname = LOG4J_LEVELS.get(record.levelname, record.levelname)
+        event = dict(name=escape(record.name),
+                     threadName=escape(record.threadName),
+                     levelname=escape(levelname),
+                     created=int(record.created * 1000))
+
+        event['message'] = LOG4J_MESSAGE % escape_cdata(record.getMessage())
+
+        # FIXME: Support an NDC somehow
+        event['ndc'] = ''
+        # ndc = self.get_ndc(record)
+        # if ndc:
+        #    event['ndc'] = LOG4J_NDC % escape_cdata(ndc)
+
+        event['throwable'] = ''
+        if record.exc_info:
+            if not record.exc_text:
+                record.exc_text = self.formatException(record.exc_info)
+            event['throwable'] = (LOG4J_THROWABLE %
+                                  escape_cdata(record.exc_text))
+
+        location_info = dict(pathname=escape(record.pathname),
+                             lineno=record.lineno,
+                             module=escape(record.module), funcName='')
+        if hasattr(record, 'funcName'):
+            # >= Python 2.5
+            location_info['funcName'] = escape(record.funcName)
+        event['locationInfo'] = LOG4J_LOCATIONINFO % location_info
+
+        return LOG4J_EVENT % event
+
+
+def escape_cdata(cdata):
+    """Escape XML CDATA content"""
+    return cdata.replace(']]>', ']]]]><![CDATA[>')
+
+
+# General logging information
+LOG4J_EVENT = """\
+<log4j:event logger="%(name)s"
+    timestamp="%(created)i"
+    level="%(levelname)s"
+    thread="%(threadName)s">
+%(message)s%(ndc)s%(throwable)s%(locationInfo)s</log4j:event>
+"""
+
+
+# The actual log message
+LOG4J_MESSAGE = """\
+    <log4j:message><![CDATA[%s]]></log4j:message>
+"""
+
+
+# log4j's 'Nested Diagnostic Context': additional, customizable information
+# included with the log record
+LOG4J_NDC = """\
+    <log4j:ndc><![CDATA[%s]]></log4j:ndc>
+"""
+
+
+# Exception information, if exc_info was included with the record
+LOG4J_THROWABLE = """\
+    <log4j:throwable><![CDATA[%s]]></log4j:throwable>
+"""
+
+
+# Traceback information
+LOG4J_LOCATIONINFO = """\
+    <log4j:locationInfo class="%(module)s"
+        method="%(funcName)s"
+        file="%(pathname)s"
+        line="%(lineno)d"/>
+"""

xmllayout2-2.0.0/xmllayout2/handlers.py

@@ -0,0 +1,33 @@
+"""logging Handlers"""
+import logging.handlers
+import sys
+
+__all__ = ['RawSocketHandler']
+
+PY3 = sys.version_info >= (3,)
+
+
+class RawSocketHandler(logging.handlers.SocketHandler):
+    """Logging Handler that writes log records to a streaming socket.
+
+    Like ``logging.handlers.SocketHandler``, but writes the actual formatted
+    log record (not a pickled version).
+    """
+
+    def emit(self, record):
+        """Emit a record.
+
+        Formats the record and writes it to the socket in binary format. If
+        there is an error with the socket, silently drop the packet. If there
+        was a problem with the socket, re-establishes the socket.
+        """
+        try:
+            msg = self.format(record)
+            if PY3:
+                self.send(msg.encode())
+            else:
+                self.send(msg.encode('utf-8'))
+        except (KeyboardInterrupt, SystemExit):
+            raise
+        except Exception:
+            self.handleError(record)

xmllayout2-2.0.0/xmllayout2/tests/test_formatters.py

@@ -0,0 +1,119 @@
+import logging
+import sys
+try:
+    from six import StringIO  # < Python3.10
+except ImportError:
+    from io import StringIO
+try:
+    import xml.etree.ElementTree as ET
+except ImportError:
+    import elementtree.ElementTree as ET
+
+from xmllayout2 import XMLLayout
+
+PY3 = sys.version_info >= (3,)
+
+LOG4J_NS = 'http://jakarta.apache.org/log4j/'
+
+log = logging.getLogger(__name__)
+stream = StringIO()
+handler = logging.StreamHandler(stream)
+xmllayout = XMLLayout()
+handler.setFormatter(xmllayout)
+log.addHandler(handler)
+log.setLevel(logging.DEBUG)
+
+
+class ElvisException(Exception):
+    def __init__(self, info):
+        self.info = info
+
+    def __str__(self):
+        return "<ElvisException: %s (TCB because he's the king baby)>" % \
+            self.info
+
+
+def test_xmllayout():
+    _test_output('')
+    _test_output('hello')
+    _test_output('hello world', level=logging.DEBUG)
+    _test_output('hello world!', level=logging.WARN, log4jlevel='WARN')
+    _test_output('hello, world!', level=logging.WARNING, log4jlevel='WARN')
+    _test_output('hello, world!!', level=logging.CRITICAL, log4jlevel='FATAL')
+    _test_output('<xml><something>&nbsp;Hi</something></xml>')
+    _test_output("""\
+{'CONTENT_LENGTH': '0',
+ 'CONTENT_TYPE': '',
+ 'HTTP_ACCEPT': '*/*',
+ 'HTTP_ACCEPT_ENCODING': 'gzip, deflate',
+ 'HTTP_ACCEPT_LANGUAGE': 'en',
+ 'HTTP_CONNECTION': 'keep-alive',
+ 'HTTP_COOKIE': ''
+ 'HTTP_HOST': 'bob.local:5000',
+ 'HTTP_USER_AGENT': 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en) AppleWebKit/419.2.1 (KHTML, like Gecko) Safari/419.3',
+ 'PATH_INFO': '/hello',
+ 'QUERY_STRING': '',
+ 'REMOTE_ADDR': '192.168.1.111',
+ 'REQUEST_METHOD': 'GET',
+ 'SCRIPT_NAME': '',
+ 'SERVER_NAME': '0.0.0.0',
+ 'SERVER_PORT': '5000',
+ 'SERVER_PROTOCOL': 'HTTP/1.1',
+ 'paste.evalexception': <pylons.error.PylonsEvalException object at 0x8c75ccc>,
+ 'wsgi.errors': <open file '<stderr>', mode 'w' at 0x81280b0>,
+ 'wsgi.input': <socket._fileobject object at 0x8c7a48c length=0>,
+ 'wsgi.multiprocess': False,
+ 'wsgi.multithread': True,
+ 'wsgi.run_once': False,
+ 'wsgi.url_scheme': 'http',
+ 'wsgi.version': (1, 0),}
+""")  # noqa
+
+
+def test_exceptions():
+    try:
+        raise ElvisException('dog')
+    except ElvisException:
+        exc_module = ''
+        if PY3:
+            exc_module = ElvisException.__module__ + '.'
+        exc_msg = ("raise ElvisException('dog')\n%sElvisException: "
+                   "<ElvisException: dog (TCB because he's the king baby)>" %
+                   exc_module)
+        _test_output('Elvis has left the building', exc_info=True,
+                     exc_msg=exc_msg)
+
+
+def test_exceptions_cdata():
+    exc_msg = 'Hello ]]> World!'
+    try:
+        raise ElvisException(exc_msg)
+    except ElvisException:
+        _test_output('Elvis has left the building', exc_info=True,
+                     exc_msg=exc_msg)
+
+
+def get_output():
+    output = stream.getvalue().rstrip()
+    stream.truncate(0)
+    return '<test xmlns:log4j="%s">%s</test>' % (LOG4J_NS, output)
+
+
+def _test_output(message, level=logging.INFO, log4jlevel=None, exc_info=None,
+                 exc_msg=None):
+    if log4jlevel is None:
+        log4jlevel = logging.getLevelName(level)
+    log.log(level, message, **dict(exc_info=exc_info))
+    output = get_output()
+    tree = ET.XML(output)
+
+    event = tree.find("{%s}event" % LOG4J_NS)
+    xml_level = event.get('level')
+    assert xml_level == log4jlevel, message
+    xml_message = tree.findtext("{%s}event/{%s}message" % (LOG4J_NS, LOG4J_NS))
+    assert message == xml_message, message
+
+    if exc_info:
+        xml_exc = tree.findtext("{%s}event/{%s}throwable" % (LOG4J_NS,
+                                                             LOG4J_NS))
+        assert exc_msg in xml_exc, message

xmllayout2-2.0.0/xmllayout2.egg-info/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.2
+Name: xmllayout2
+Version: 2.0.0
+Summary: Formats Python log messages as log4j XMLLayout XML
+Home-page: http://pypi.python.org/pypi/XMLLayout
+Author: Jonas Lindner
+Author-email: jonaslindner55@gmail.com
+License: BSD
+Keywords: logging log4j
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Topic :: System :: Logging
+Description-Content-Type: text/markdown; charset=UTF-8
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=6.2.2; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: summary
+
+XMLLayout2 provides a Python logging Formatter that formats log messages as XML,
+according to `log4j's [XMLLayout specification](https://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/XMLLayout.html)
+
+XMLLayout formatted log messages can be viewed and filtered within the
+[Chainsaw](https://logging.apache.org/chainsaw/2.x) application
+(see the example section below), part of the Java based log4j project.
+
+This package also includes a RawSocketHandler -- like
+logging.handler.SocketHandler, but sends the raw log message over the socket
+instead of a pickled version. RawSocketHandler can be configured to send log
+messages to Chainsaw directly over a socket.
+
+For example: to forward log messages to Chainsaw, if it were listening on
+localhost port 4448::
+
+    import logging
+    import xmllayout2
+
+    handler = xmllayout2.RawSocketHandler('localhost', 4448)
+    handler.setFormatter(xmllayout2.XMLLayout())
+    logging.root.addHandler(handler)
+
+This is a fork of Philip Jenveys original package xmllayout. Maintained for usage in commercial projects, with supporting a variety of Python versions.
+
+Installation via pip:
+pip install xmllayout2

xmllayout2-2.0.0/xmllayout2.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+.gitattributes
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+xmllayout2/__init__.py
+xmllayout2/formatters.py
+xmllayout2/handlers.py
+xmllayout2.egg-info/PKG-INFO
+xmllayout2.egg-info/SOURCES.txt
+xmllayout2.egg-info/dependency_links.txt
+xmllayout2.egg-info/not-zip-safe
+xmllayout2.egg-info/requires.txt
+xmllayout2.egg-info/top_level.txt
+xmllayout2/tests/__init__.py
+xmllayout2/tests/test_formatters.py

xmllayout2-2.0.0/xmllayout2.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

xmllayout2-2.0.0/xmllayout2.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

xmllayout2-2.0.0/xmllayout2.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[test]
+pytest>=6.2.2

xmllayout2-2.0.0/xmllayout2.egg-info/top_level.txt

@@ -0,0 +1 @@
+xmllayout2