dilim/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2026-07-21 15:00:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

systemd-python: update Journal python docstrings

Browse Source
This commit is contained in:
Steven Hiscocks
2013-02-17 11:55:45 +00:00
committed by Zbigniew Jędrzejewski-Szmek
parent b835982344
commit c71f26eba5
2 changed files with 58 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/python-systemd/_reader.c
View File

@@ -57,7 +57,7 @@ Journal_init(Journal *self, PyObject *args, PyObject *keywds)
char *path=NULL;
static char *kwlist[] = {"flags", "path", NULL};
if (! PyArg_ParseTupleAndKeywords(args, keywds, "|is", kwlist,
if (! PyArg_ParseTupleAndKeywords(args, keywds, "|iz", kwlist,
&flags, &path))
return 1;

73
src/python-systemd/journal.py
View File

@@ -79,21 +79,34 @@ else:
_convert_unicode = _functools.partial(unicode, encoding='utf-8')
class Journal(_Journal):
def __init__(self, converters=None, *args, **kwargs):
super(Journal, self).__init__(*args, **kwargs)
if sys.version_info >= (3,3):
def __init__(self, converters=None, flags=LOCAL_ONLY, path=None):
"""Creates instance of Journal, which allows filtering and
return of journal entries.
Argument `converters` is a dictionary which updates the
DEFAULT_CONVERTERS to convert journal field values.
Argument `flags` sets open flags of the journal, which can be one
of, or ORed combination of constants: LOCAL_ONLY (default) opens
journal on local machine only; RUNTIME_ONLY opens only
volatile journal files; and SYSTEM_ONLY opens only
journal files of system services and the kernel.
Argument `path` is the directory of journal files. Note that
currently flags are ignored when `path` is present as they are
currently not relevant.
"""
super(Journal, self).__init__(flags, path)
if _sys.version_info >= (3,3):
self.converters = ChainMap()
if converters is not None:
self.converters.maps.append(converters)
self.converters.maps.append(DEFAULT_CONVERTERS)
else:
# suitable fallback, e.g.
self.converters = DEFAULT_CONVERTERS.copy()
if converters is not None:
self.converters.update(converters)
def _convert_field(self, key, value):
""" Convert value based on callable from self.converters
based of field/key"""
try:
result = self.converters[key](value)
except:
@@ -106,6 +119,7 @@ class Journal(_Journal):
return result
def _convert_entry(self, entry):
""" Convert entire journal entry utilising _covert_field"""
result = {}
for key, value in entry.items():
if isinstance(value, list):
@@ -115,31 +129,54 @@ class Journal(_Journal):
return result
def add_match(self, *args, **kwargs):
"""Add one or more matches to the filter journal log entries.
All matches of different field are combined in a logical AND,
and matches of the smae field are automatically combined in a
logical OR.
Matches can be passed as strings of form "field=value", or
keyword arguments field="value"."""
args = list(args)
args.extend(_make_line(key, val) for key, val in kwargs.items())
for arg in args:
super(Journal, self).add_match(arg)
def get_next(self, skip=1):
"""Return dictionary of the next log entry. Optional skip value
will return the `skip`th log entry.
Returned will be journal entry dictionary processed with
converters."""
return self._convert_entry(
super(Journal, self).get_next(skip))
def query_unique(self, key):
return set(self._convert_field(key, value)
for value in super(Journal, self).query_unique(key))
def query_unique(self, field):
"""Returns a set of unique values in journal for given `field`,
processed with converters.
Note this does not respect any journal matches."""
return set(self._convert_field(field, value)
for value in super(Journal, self).query_unique(field))
def seek_realtime(self, timestamp):
def seek_realtime(self, realtime):
"""Seek to nearest matching journal entry to `realtime`.
Argument `realtime` can must be either an integer unix timestamp
or datetime.datetime instance."""
if isinstance(realtime, _datetime.datetime):
timestamp = float(timestamp.strftime("%s.%f"))
return super(Journal, self).seek_realtime(timestamp)
realtime = float(realtime.strftime("%s.%f"))
return super(Journal, self).seek_realtime(realtime)
def seek_monotonic(self, timestamp, bootid=None):
def seek_monotonic(self, monotonic, bootid=None):
"""Seek to nearest matching journal entry to `monotonic`.
Argument `monotonic` is a timestamp from boot in either seconds
or a datetime.timedelta instance.
Argument `bootid` is a string or UUID representing which boot the
monotonic time is reference to. Defaults to current bootid."""
if isinstance(monotonic, _datetime.timedelta):
timestamp = timestamp.totalseconds()
return super(Journal, self).seek_monotonic(timestamp, bootid)
monotonic = monotonic.totalseconds()
if isinstance(bootid, _uuid.UUID):
bootid = bootid.get_hex()
return super(Journal, self).seek_monotonic(monotonic, bootid)
def log_level(self, level):
"""Sets maximum log level by setting matches for PRIORITY."""
"""Sets maximum log `level` by setting matches for PRIORITY."""
if 0 <= level <= 7:
for i in range(level+1):
self.add_match(PRIORITY="%s" % i)
@@ -149,7 +186,9 @@ class Journal(_Journal):
def this_boot(self, bootid=None):
"""Add match for _BOOT_ID equal to current boot ID or the specified boot ID.
bootid should be either a UUID or a 32 digit hex number.
If specified, bootid should be either a UUID or a 32 digit hex number.
Equivalent to add_match(_BOOT_ID='bootid').
"""
if bootid is None:
bootid = _id128.get_boot().hex
@@ -160,7 +199,9 @@ class Journal(_Journal):
def this_machine(self, machineid=None):
"""Add match for _MACHINE_ID equal to the ID of this machine.
bootid should be either a UUID or a 32 digit hex number.
If specified, machineid should be either a UUID or a 32 digit hex number.
Equivalent to add_match(_MACHINE_ID='machineid').
"""
if machineid is None:
machineid = _id128.get_machine().hex