systemd-logging 1.0.0__tar.gz → 1.0.2__tar.gz

systemd_logging-1.0.2/.gitignore

@@ -0,0 +1,11 @@
+.project
+.pydevproject
+.idea
+.tox
+.venv
+__pycache__
+*.pyc
+*.pyo
+*.egg-info
+*.lock
+site/

{systemd-logging-1.0.0 → systemd_logging-1.0.2}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019-2021, Igor `idle sign` Starikov
+Copyright (c) 2019-2026, Igor `idle sign` Starikov
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

systemd_logging-1.0.2/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.5
+Name: systemd-logging
+Version: 1.0.2
+Summary: Simplifies logging for systemd
+Project-URL: Homepage, https://github.com/idlesign/systemd-logging
+Author-email: Igor Starikov <idlesign@yandex.ru>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: journal,logging,systemd
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.10
+Requires-Dist: ctyped>=0.7.1
+Description-Content-Type: text/markdown
+
+# systemd-logging
+
+<https://github.com/idlesign/systemd-logging>
+
+[![release](https://img.shields.io/pypi/v/systemd-logging.svg)](https://pypi.python.org/pypi/systemd-logging)
+[![lic](https://img.shields.io/pypi/l/systemd-logging.svg)](https://pypi.python.org/pypi/systemd-logging)
+[![coverage](https://img.shields.io/coveralls/idlesign/systemd-logging/master.svg)](https://coveralls.io/r/idlesign/systemd-logging)
+
+## Description
+
+*Simplifies logging for systemd*
+
+**Requires Python 3.10+**
+
+* No need to compile (pure Python), uses `libsystemd.so`.
+* Simplified configuration.
+* Just logging. Nothing more.
+
+## Usage
+
+```python
+import logging
+
+from systemdlogging.toolbox import init_systemd_logging
+
+# This one line in most cases would be enough.
+# By default it attaches systemd logging handler to a root Python logger.
+init_systemd_logging()  # Returns True if initialization went fine.
+
+# Now you can use logging as usual.
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+logger.debug('My debug message')
+
+try:
+    raise ValueError('Log me please')
+
+except ValueError:
+    # Additional context can be passed in extra.context.
+    logger.exception('Something terrible just happened', extra={
+        'message_id': True,  # Generate message ID automatically.
+        'context': {
+            'FIELD1': 'one',
+            'FIELD2': 'two',
+        }
+    }, stack_info=True)
+```

systemd_logging-1.0.2/README.md

@@ -0,0 +1,48 @@
+# systemd-logging
+
+<https://github.com/idlesign/systemd-logging>
+
+[![release](https://img.shields.io/pypi/v/systemd-logging.svg)](https://pypi.python.org/pypi/systemd-logging)
+[![lic](https://img.shields.io/pypi/l/systemd-logging.svg)](https://pypi.python.org/pypi/systemd-logging)
+[![coverage](https://img.shields.io/coveralls/idlesign/systemd-logging/master.svg)](https://coveralls.io/r/idlesign/systemd-logging)
+
+## Description
+
+*Simplifies logging for systemd*
+
+**Requires Python 3.10+**
+
+* No need to compile (pure Python), uses `libsystemd.so`.
+* Simplified configuration.
+* Just logging. Nothing more.
+
+## Usage
+
+```python
+import logging
+
+from systemdlogging.toolbox import init_systemd_logging
+
+# This one line in most cases would be enough.
+# By default it attaches systemd logging handler to a root Python logger.
+init_systemd_logging()  # Returns True if initialization went fine.
+
+# Now you can use logging as usual.
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+
+logger.debug('My debug message')
+
+try:
+    raise ValueError('Log me please')
+
+except ValueError:
+    # Additional context can be passed in extra.context.
+    logger.exception('Something terrible just happened', extra={
+        'message_id': True,  # Generate message ID automatically.
+        'context': {
+            'FIELD1': 'one',
+            'FIELD2': 'two',
+        }
+    }, stack_info=True)
+```

systemd_logging-1.0.2/pyproject.toml

@@ -0,0 +1,76 @@
+[project]
+name = "systemd-logging"
+dynamic = ["version"]
+description = "Simplifies logging for systemd"
+authors = [
+    { name = "Igor Starikov", email = "idlesign@yandex.ru" },
+]
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = ["systemd", "journal", "logging"]
+dependencies = [
+    "ctyped>=0.7.1",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "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",
+    "License :: OSI Approved :: BSD License",
+]
+
+[project.urls]
+Homepage = "https://github.com/idlesign/systemd-logging"
+
+[dependency-groups]
+dev = [
+    { include-group = "docs" },
+    { include-group = "linters" },
+    { include-group = "tests" },
+]
+docs = [
+    "mkdocs-apidescribed-plugin",
+    "mkdocs-material",
+    "mkdocs-navsorted-plugin",
+]
+linters = [
+    "ruff==0.13.1",
+]
+tests = [
+    "coverage",
+    "pytest",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/systemdlogging/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/systemdlogging"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/"]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+source = [
+    "src/systemdlogging",
+]
+
+[tool.makeapp.tests]
+deps = []

systemd_logging-1.0.2/src/systemdlogging/__init__.py

@@ -0,0 +1 @@
+VERSION = '1.0.2'

{systemd-logging-1.0.0 → systemd_logging-1.0.2/src}/systemdlogging/toolbox.py

@@ -2,7 +2,6 @@ import logging
 import os
 import syslog
 import uuid
-from typing import Optional
 
 from .backend_ctyped import send, send_stub
 
@@ -15,7 +14,7 @@ PRIORITY_MAP = {
 }
 
 
-def log_message(*, level: int, msg: str, context: Optional[dict] = None) -> bool:
+def log_message(*, level: int, msg: str, context: dict | None = None) -> bool:
     """Sends a message to systemd.
 
     .. warning:: Low level function. You may want to
@@ -30,14 +29,16 @@ def log_message(*, level: int, msg: str, context: Optional[dict] = None) -> bool
 
     """
     args = {
+        'MESSAGE': msg,
         'PRIORITY': PRIORITY_MAP.get(level, level),
     }
 
     args.update(context or {})
 
     return send(
-        b'MESSAGE=%s', msg.encode(),  # Prevents %-formatting in messages.
-        *[f'{key}={val}'.encode() for key, val in args.items()],
+        # escape % in values to prevent segfaults
+        # while trying to format things like %s, %d, etc.
+        *[f'{key}={val}'.replace('%', '%%').encode() for key, val in args.items()],
         None
     ) == 0
 
@@ -149,10 +150,23 @@ def check_for_systemd() -> bool:
     is connected to journald).
 
     """
-    return (send is not send_stub) and bool(os.environ.get('INVOCATION_ID'))  # Works with systemd v232+
+    if send is send_stub:
+        return False
 
+    journal_stream = os.environ.get("JOURNAL_STREAM")  # systemd v231+
 
-def init_systemd_logging(*, logger: Optional[logging.Logger] = None, syslog_id: str = '') -> bool:
+    if journal_stream:
+        # Output streams might have been replaced by a wrapping process,
+        # so verify that stdout/stderr are still connected to the journal.
+        return any(
+            f"{stat.st_dev}:{stat.st_ino}" == journal_stream
+            for stat in (os.fstat(fd) for fd in (1, 2))
+        )
+
+    return bool(os.environ.get("INVOCATION_ID"))  # Works with systemd v232+
+
+
+def init_systemd_logging(*, logger: logging.Logger | None = None, syslog_id: str = '') -> bool:
     """Initializes logging to send log messages to systemd.
 
     Returns boolean indicating initialization went fine (see also `check_for_systemd()`).

systemd-logging-1.0.0/AUTHORS

@@ -1,18 +0,0 @@
-systemd-logging authors
-=======================
-
-Created by Igor `idle sign` Starikov.
-
-
-Contributors
-------------
-
-Here could be your name.
-
-
-
-Translators
------------
-
-Here could be your name.
-

systemd-logging-1.0.0/CHANGELOG

@@ -1,29 +0,0 @@
-systemd-logging changelog
-=========================
-
-
-v1.0.0 [2021-07-14]
--------------------
-* Celebrating 1.0.0.
-* CtypedException is now hidden to improve plugability (see #5).
-
-
-v0.3.1 [2021-01-25]
--------------------
-* Proper % handling in messages (see #3).
-
-
-v0.3.0 [2020-01-28]
--------------------
-+ init_systemd_logging() now tries to detect systemd and returns boolean.
-
-
-v0.2.0 [2019-10-15]
--------------------
-+ Added an option to set SYSLOG_IDENTIFIER.
-* Removed PROCESS_ID field in favor of _PID.
-
-
-v0.1.0 [2019-10-14]
--------------------
-+ Basic functionality.

systemd-logging-1.0.0/INSTALL

@@ -1,31 +0,0 @@
-systemd-logging installation
-============================
-
-
-Python ``pip`` package is required to install ``systemd-logging``.
-
-
-From sources
-------------
-
-Use the following command line to install ``systemd-logging`` from sources directory (containing setup.py):
-
-    pip install .
-
-or
-
-    python setup.py install
-
-
-From PyPI
----------
-
-Alternatively you can install ``systemd-logging`` from PyPI:
-
-    pip install systemd-logging
-
-
-Use `-U` flag for upgrade:
-
-    pip install -U systemd-logging
-

systemd-logging-1.0.0/MANIFEST.in

@@ -1,15 +0,0 @@
-include AUTHORS
-include CHANGELOG
-include INSTALL
-include LICENSE
-include README.rst
-
-include docs/Makefile
-recursive-include docs *.rst
-recursive-include docs *.py
-recursive-include tests *
-
-recursive-exclude * __pycache__
-recursive-exclude * *.py[co]
-recursive-exclude * empty
-

systemd-logging-1.0.0/PKG-INFO

@@ -1,87 +0,0 @@
-Metadata-Version: 1.1
-Name: systemd-logging
-Version: 1.0.0
-Summary: Simplifies logging for systemd
-Home-page: https://github.com/idlesign/systemd-logging
-Author: Igor `idle sign` Starikov
-Author-email: idlesign@yandex.ru
-License: BSD 3-Clause License
-Description: systemd-logging
-        ===============
-        https://github.com/idlesign/systemd-logging
-        
-        |release| |lic| |coverage|
-        
-        .. |release| image:: https://img.shields.io/pypi/v/systemd-logging.svg
-            :target: https://pypi.python.org/pypi/systemd-logging
-        
-        .. |lic| image:: https://img.shields.io/pypi/l/systemd-logging.svg
-            :target: https://pypi.python.org/pypi/systemd-logging
-        
-        .. |coverage| image:: https://img.shields.io/coveralls/idlesign/systemd-logging/master.svg
-            :target: https://coveralls.io/r/idlesign/systemd-logging
-        
-        
-        Description
-        -----------
-        
-        *Simplifies logging for systemd*
-        
-        **Requires Python 3.6+**
-        
-        * No need to compile (pure Python), uses ``libsystemd.so``.
-        * Simplified configuration.
-        * Just logging. Nothing more.
-        
-        
-        Usage
-        -----
-        
-        .. code-block:: python
-        
-            import logging
-        
-            from systemdlogging.toolbox import init_systemd_logging
-        
-            # This one line in most cases would be enough.
-            # By default it attaches systemd logging handler to a root Python logger.
-            init_systemd_logging()  # Returns True if initialization went fine.
-        
-            # Now you can use logging as usual.
-            logger = logging.getLogger(__name__)
-            logger.setLevel(logging.DEBUG)
-        
-            logger.debug('My debug message')
-        
-            try:
-                raise ValueError('Log me please')
-        
-            except ValueError:
-                # Additional context can be passed in extra.context.
-                logger.exception('Something terrible just happened', extra={
-                    'message_id': True,  # Generate message ID automatically.
-                    'context': {
-                        'FIELD1': 'one',
-                        'FIELD2': 'two',
-                    }
-                }, stack_info=True)
-        
-        
-        Read the docs to find out more.
-        
-        
-        Documentation
-        -------------
-        
-        https://systemd-logging.readthedocs.org/
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: License :: OSI Approved :: BSD License

systemd-logging-1.0.0/README.rst

@@ -1,68 +0,0 @@
-systemd-logging
-===============
-https://github.com/idlesign/systemd-logging
-
-|release| |lic| |coverage|
-
-.. |release| image:: https://img.shields.io/pypi/v/systemd-logging.svg
-    :target: https://pypi.python.org/pypi/systemd-logging
-
-.. |lic| image:: https://img.shields.io/pypi/l/systemd-logging.svg
-    :target: https://pypi.python.org/pypi/systemd-logging
-
-.. |coverage| image:: https://img.shields.io/coveralls/idlesign/systemd-logging/master.svg
-    :target: https://coveralls.io/r/idlesign/systemd-logging
-
-
-Description
------------
-
-*Simplifies logging for systemd*
-
-**Requires Python 3.6+**
-
-* No need to compile (pure Python), uses ``libsystemd.so``.
-* Simplified configuration.
-* Just logging. Nothing more.
-
-
-Usage
------
-
-.. code-block:: python
-
-    import logging
-
-    from systemdlogging.toolbox import init_systemd_logging
-
-    # This one line in most cases would be enough.
-    # By default it attaches systemd logging handler to a root Python logger.
-    init_systemd_logging()  # Returns True if initialization went fine.
-
-    # Now you can use logging as usual.
-    logger = logging.getLogger(__name__)
-    logger.setLevel(logging.DEBUG)
-
-    logger.debug('My debug message')
-
-    try:
-        raise ValueError('Log me please')
-
-    except ValueError:
-        # Additional context can be passed in extra.context.
-        logger.exception('Something terrible just happened', extra={
-            'message_id': True,  # Generate message ID automatically.
-            'context': {
-                'FIELD1': 'one',
-                'FIELD2': 'two',
-            }
-        }, stack_info=True)
-
-
-Read the docs to find out more.
-
-
-Documentation
--------------
-
-https://systemd-logging.readthedocs.org/

systemd-logging-1.0.0/docs/Makefile

@@ -1,131 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = build
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-
-clean:
-	-rm -rf $(BUILDDIR)/*
-
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/systemd-logging.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/systemd-logging.qhc"
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/systemd-logging"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/systemd-logging"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	make -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-

systemd-logging-1.0.0/docs/source/api.rst

@@ -1,5 +0,0 @@
-API
-===
-
-.. automodule:: systemdlogging.toolbox
-   :members: