Version 0.6.0: add _enabled methods, typing, improved tests, docs

Author: simonrob

.gitignore

@@ -129,7 +129,10 @@ dmypy.json
 .pyre/
 
 # Custom for this repository
-versions
-build.sh
-.idea
 *.iml
+.idea
+build.sh
+versions
+
+# duplicate of master readme (to integrate in docs)
+docs/readme.md

README.md

@@ -1,5 +1,5 @@
 # Pyoslog
-Pyoslog is a simple Python module that allows you to send messages to the macOS [unified logging system](https://developer.apple.com/documentation/os/os_log).
+Pyoslog allows you to send messages to the macOS [unified logging system](https://developer.apple.com/documentation/os/os_log) using Python.
 
 ```python
 from pyoslog import os_log, OS_LOG_DEFAULT
@@ -8,27 +8,37 @@ os_log(OS_LOG_DEFAULT, 'Hello from Python!')
 
 
 ## Installation
-Pyoslog requires macOS 10.12 or later.
+Pyoslog requires macOS 10.12 or later and Python 3.6 or later.
 Install using `pip`:
 
 ```shell
 python -m pip install pyoslog
 ```
 
-The module will install and import without error on earlier macOS versions (and on unsupported Operating Systems and Python versions).
-Use `pyoslog.is_supported()` if you need to support old macOS versions or other environments and want to know at runtime whether to use pyoslog.
+The module will install and import without error on earlier macOS versions, or on unsupported Operating Systems or incompatible Python versions.
+Use `pyoslog.is_supported()` if you need to support incompatible environments and want to know at runtime whether to use pyoslog.
 Please note that if `is_supported()` returns `False` then none of the module's other methods or constants will exist.
 
 
 ## Usage
-Pyoslog currently provides the methods [`os_log_create`](https://developer.apple.com/documentation/os/1643744-os_log_create), [`os_log_with_type`](https://developer.apple.com/documentation/os/os_log_with_type) and [`os_log`](https://developer.apple.com/documentation/os/os_log), each with the same signatures as their native versions.
+Pyoslog currently provides the following methods:
+- [`os_log_create`](https://developer.apple.com/documentation/os/1643744-os_log_create)
+- [`os_log_type_enabled`](https://developer.apple.com/documentation/os/1643749-os_log_type_enabled) (and [`info`](https://developer.apple.com/documentation/os/os_log_info_enabled)/[`debug`](https://developer.apple.com/documentation/os/os_log_debug_enabled) variants)
+- [`os_log_with_type`](https://developer.apple.com/documentation/os/os_log_with_type)
+- [`os_log`](https://developer.apple.com/documentation/os/os_log) (and [`info`](https://developer.apple.com/documentation/os/os_log_info)/[`debug`](https://developer.apple.com/documentation/os/os_log_debug)/[`error`](https://developer.apple.com/documentation/os/os_log_error)/[`fault`](https://developer.apple.com/documentation/os/os_log_fault) variants).
 
-The module also offers a helper method – `log` – that by default posts a message of type `OS_LOG_TYPE_DEFAULT` to `OS_LOG_DEFAULT`.
+All the pyoslog methods have the same signatures as their native versions, _except_ for where a method requires a `format` parameter.
+The `os_log` system requires a constant (static) format specifier, and it is not possible to achieve this via Python.
+As a result, all instances of format strings use `"%{public}s"`, and all messages are converted to a string before passing to the native methods.
+
+Pyoslog also offers a helper method – `log` – that by default posts a message of type `OS_LOG_TYPE_DEFAULT` to `OS_LOG_DEFAULT`.
 For example, the shortcut `log('message')` is equivalent to `os_log_with_type(OS_LOG_DEFAULT, OS_LOG_TYPE_DEFAULT, 'message')`.
 
 The `Handler` class is designed for use with Python's inbuilt [logging](https://docs.python.org/3/library/logging.html) module.
 It works as a drop-in replacement for other Handler varieties.
 
+See [pyoslog's Read the Docs entry](https://pyoslog.readthedocs.io/) for a full reference. 
+
 ### Labelling subsystem and category
 Create a log object using `os_log_create` and pass it to any of the log methods to add your own subsystem and category labels:
 
@@ -38,6 +48,26 @@ log = pyoslog.os_log_create('ac.robinson.pyoslog', 'custom-category')
 pyoslog.os_log_with_type(log, pyoslog.OS_LOG_TYPE_DEBUG, 'Message to log object', log, 'of type', pyoslog.OS_LOG_TYPE_DEBUG)
 ```
 
+### Enabling and disabling log output
+Log output can be enabled or disabled globally by switching between the desired log object and `pyoslog.OS_LOG_DISABLED`:
+
+```python
+import pyoslog
+log = pyoslog.OS_LOG_DEFAULT
+pyoslog.os_log(log, 'Log output enabled')
+log = pyoslog.OS_LOG_DISABLED
+pyoslog.os_log(log, 'Log output disabled')
+```
+
+It is also possible to check whether individual log types are enabled for a particular log object:
+
+```python
+import pyoslog
+pyoslog.os_log_type_enabled(pyoslog.OS_LOG_DEFAULT, pyoslog.OS_LOG_TYPE_DEBUG)
+```
+
+It is not possible to directly set a log object's mode from Python, but see the `config` section of `man log` for documentation about doing this in `sudo` mode.
+
 ### Integration with the logging module
 Use the pyoslog `Handler` to direct messages to pyoslog:
 
@@ -59,14 +89,14 @@ Logs can be viewed using Console.app or the `log` command.
 For example, messages sent using the default configuration can be streamed using:
 
 ```shell
-log stream --predicate 'processImagePath CONTAINS "Python"'
+log stream --predicate 'processImagePath CONTAINS [c] "python"'
 ```
 
-Messages sent using custom configurations can be filtered more precisely.
+Messages sent using custom log objects can be filtered more precisely.
 For example, to receive messages from the labelled subsystem used in the example above:
 
 ```shell
-log stream --predicate 'subsystem == "ac.robinson.pyoslog"' --level=debug
+log stream --predicate 'subsystem == "ac.robinson.pyoslog"' --level debug
 ```
 
 See `man log` for further details about the available options and filters.
@@ -84,11 +114,14 @@ After installing the OSLog wrappers (via `python -m pip install pyobjc-framework
 python -m unittest
 ```
 
+Please note that if Console.app is live-streaming messages, some tests may fail.
+See [`test_logging.py`](https://github.com/simonrob/pyoslog/blob/main/tests/test_logging.py#L84) for discussion about why this is the case.
+
 
 ## Alternatives
 At the time this module was created there were no alternatives available on [PyPi](https://pypi.org/search/?q=macos+unified+logging&c=Operating+System+%3A%3A+MacOS).
 Since then, the [macos-oslog](https://pypi.org/project/macos-oslog/) module has been released, with broadly equivalent functionality to pyoslog.
-There are also other options available if PyPi access is not seen as a constraint:
+In addition, there are other options available if PyPi access is not seen as a constraint:
 
 - [apple_os_log_py](https://github.com/cedar101/apple_os_log_py)
 - [pymacoslog](https://github.com/douglas-carmichael/pymacoslog)

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

@@ -0,0 +1,3 @@
+.function, .method {
+    margin-bottom: 1em;
+}

docs/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import datetime
+import os
+import sys
+
+# Make sure pyoslog's source files are detected
+sys.path.insert(0, os.path.abspath('..'))
+
+# Get properties from __version__.py
+about = {}
+with open(os.path.join(os.path.abspath('..'), 'pyoslog', '__version__.py')) as version_file:
+    exec(version_file.read(), about)
+
+# Import the main README.md
+with open(os.path.join(os.path.abspath('.'), 'readme.md'), 'w') as output_file:
+    output_file.write("# Overview\n", )
+    lines = []
+    with open(os.path.join(os.path.abspath('..'), 'README.md')) as readme:
+        for line in readme:
+            if line.startswith('# '):  # skip main title (we name it 'Overview' above)
+                continue
+            lines.append(line.rstrip())
+    output_file.write('\n'.join(lines))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = about['__title__']
+
+# noinspection PyShadowingBuiltins
+copyright = '%d, %s' % (datetime.datetime.now().year, about['__author__'])
+author = about['__author__']
+version = about['__version__']
+release = about['__version__']
+
+print('Documenting', project, version)
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'recommonmark'  # note: https://github.com/readthedocs/recommonmark/issues/177
+]
+source_suffix = ['.rst', '.md']
+
+autodoc_member_order = 'bysource'  # note: doesn't work with inherited members: github.com/sphinx-doc/sphinx/issues/628
+autodoc_preserve_defaults = True  # better display of log() defaults
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_static_path = ['_static']
+html_theme = 'alabaster'

docs/index.rst

@@ -0,0 +1,15 @@
+Pyoslog
+=======
+Send messages to the macOS `unified logging system <https://developer.apple.com/documentation/os/os_log>`_ using Python.
+
+
+Table of contents
++++++++++++++++++
+.. toctree::
+    :maxdepth: 3
+
+    readme
+
+    reference
+
+* :ref:`genindex`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/reference.rst

@@ -0,0 +1,58 @@
+Reference
+=========
+See `Apple's documentation <https://developer.apple.com/documentation/os/logging?language=objc>`_ for further
+information about macOS logging.
+
+
+Constants
++++++++++
+
+Log objects
+------------
+
+.. py:data:: pyoslog.OS_LOG_DEFAULT
+    :type: os_log_t
+    :value: The shared disabled log.
+
+.. py:data:: pyoslog.OS_LOG_DISABLED
+    :type: os_log_t
+    :value: The shared default log.
+
+Log levels/types
+----------------
+
+.. py:data:: pyoslog.OS_LOG_TYPE_DEBUG
+    :type: int
+    :value: The debug log level.
+
+.. py:data:: pyoslog.OS_LOG_TYPE_INFO
+    :type: int
+    :value: The informational log level.
+
+.. py:data:: pyoslog.OS_LOG_TYPE_DEFAULT
+    :type: int
+    :value: The default log level.
+
+.. py:data:: pyoslog.OS_LOG_TYPE_ERROR
+    :type: int
+    :value: The error log level.
+
+.. py:data:: pyoslog.OS_LOG_TYPE_FAULT
+    :type: int
+    :value: The fault log level.
+
+
+Methods
++++++++
+
+.. automodule:: pyoslog
+    :imported-members:
+    :members:
+    :exclude-members: Handler
+
+
+Handler
++++++++
+
+.. autoclass:: pyoslog.Handler
+    :members:

pyoslog/__init__.py

@@ -1,8 +1,14 @@
-""""Send messages to the macOS unified logging system. See: https://developer.apple.com/documentation/os/os_log"""
 from .compatibility import is_supported
 
 if is_supported():
     from .core import *
     from .handler import *
 
-del compatibility
+    # remove globals so they are not revealed to importers
+    del core  # type: ignore
+    del handler  # type: ignore
+
+    del py_object
+    del os_log_t
+
+del compatibility  # type: ignore

pyoslog/__version__.py

@@ -1,5 +1,5 @@
 __title__ = 'pyoslog'
-__version__ = '0.5.0'
+__version__ = '0.6.0'
 __description__ = 'Send messages to the macOS unified logging system'
 __author__ = 'Simon Robinson'
 __author_email__ = 'simon@robinson.ac'