moinlight 0.4.5__py3-none-any.whl

moinformat/__init__.py

@@ -0,0 +1,30 @@
+"""
+Moin wiki format tools.
+
+Copyright (C) 2017, 2018, 2019 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from moinformat.input import make_input
+from moinformat.links import make_linker
+from moinformat.metadata import Metadata
+from moinformat.output import make_output
+from moinformat.parsers import get_parser, make_parser, parse
+from moinformat.serialisers import get_serialiser, make_serialiser, serialise
+from moinformat.themes import make_theme
+from moinformat.utils.copying import copy_attachments
+import moinformat.errors as errors
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/errors.py

@@ -0,0 +1,33 @@
+"""
+Moin wiki processing errors.
+
+Copyright (C) 2019 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+class ProcessingError(Exception):
+
+    "A generic processing error."
+
+    def __init__(self, errors):
+        self.errors = errors
+
+    def __repr__(self):
+        return "%s(%r)" % (self.__class__.__name__, self.errors)
+
+    def __str__(self):
+        return "Error: %s\nMessage: %s\n" % (self.__class__.__name__, self.errors)
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/imports.py

@@ -0,0 +1,88 @@
+"""
+Import utilities.
+
+Copyright (C) 2017, 2018, 2021 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from os.path import isdir, join, split, splitext
+from os import listdir
+from importlib import import_module
+
+reserved = ["__init__", "common", "manifest"]
+
+def get_extensions(dirname, modname, stores, reserved, prefix=None):
+
+    "Import extensions inside 'dirname'."
+
+    for filename in listdir(dirname):
+        pathname = join(dirname, filename)
+
+        # Descend into directories, prefixing the identified modules.
+
+        if isdir(pathname):
+            store_name = prefix and "%s.%s" % (prefix, modname) or filename
+            get_extensions(pathname, "%s.%s" % (modname, filename),
+                           stores, reserved, store_name)
+            continue
+
+        # Identify modules and import them.
+
+        leafname, ext = splitext(filename)
+
+        if ext == ".py" and leafname not in reserved:
+            store_name = prefix and "%s.%s" % (prefix, leafname) or leafname
+            stores[store_name] = import_module("%s.%s" % (modname, leafname))
+
+def get_mapping(modules, get_keys, get_value):
+
+    """
+    Using the 'modules' mapping, employ 'get_keys' and 'get_value' to register
+    objects provided by the modules in a mapping.
+    """
+
+    mapping = {}
+
+    # Use the callables to obtain the keys and values from modules.
+
+    for name, module in modules.items():
+        keys = get_keys(name, module)
+        if keys:
+
+            # Make a mapping for each key to the module concerned.
+
+            for key in keys:
+                mapping[key] = get_value(module)
+
+    return mapping
+
+def get_modules(module_file, module_name):
+
+    """
+    Obtain details of the indicated module's package using 'module_file',
+    corresponding to a __file__ attribute, and 'module_name', corresponding to
+    a __name__ attribute.
+    """
+
+    dirname = split(module_file)[0]
+    package = module_name.rsplit(".", 1)[0]
+
+    # Define an attribute mapping names to modules.
+
+    modules = {}
+    get_extensions(dirname, package, modules, reserved)
+    return modules
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/input/__init__.py

@@ -0,0 +1,39 @@
+"""
+Input contexts.
+
+Copyright (C) 2018 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from moinformat.input.manifest import inputs
+
+# Top-level functions.
+
+def get_input(name):
+
+    """
+    Return the input context class with the given 'name' or None if no such
+    class is found.
+    """
+
+    return inputs.get(name)
+
+def make_input(metadata, name=None):
+
+    "Return an input context using 'metadata' and the optional 'name'."
+
+    return metadata.get_input(name)
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/input/common.py

@@ -0,0 +1,167 @@
+"""
+Input context common functionality.
+
+Copyright (C) 2018, 2019, 2026 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from moinformat.utils.file import readfile
+from os.path import exists, split
+import codecs
+import re
+
+class Input:
+
+    "A common input context abstraction."
+
+    default_encoding = "utf-8"
+
+    def __init__(self, metadata):
+
+        "Initialise the input context with the given 'metadata'."
+
+        self.metadata = metadata
+
+        # Obtain essential metadata.
+
+        self.encoding = metadata.get("input_encoding", self.default_encoding)
+
+    def all(self):
+
+        "Return all pages in the context."
+
+        return []
+
+    def all_attachments(self):
+
+        "Return all attachment filenames in the context."
+
+        return []
+
+    def get_attachments(self, pagename):
+
+        "Return all attachment filenames for the given 'pagename'."
+
+        return []
+
+    def current_revision(self, pagename):
+
+        "Return the current revision for the given 'pagename'."
+
+        return None
+
+    def find(self, pattern):
+
+        "Return all pagenames matching the given regular expression 'pattern'."
+
+        found = []
+
+        p = re.compile(pattern)
+
+        for pagename in self.all():
+            if p.match(pagename):
+                found.append(pagename)
+
+        return found
+
+    def revisions(self, pagename):
+
+        "Return all revisions for the given 'pagename'."
+
+        return [None]
+
+    def provides_history(self):
+
+        "Return whether the context provides revision history."
+
+        return False
+
+    # Page characteristics.
+
+    def parent(self, pagename):
+
+        "Return the parent of 'pagename'."
+
+        return "/" in pagename and pagename.rsplit("/", 1)[0] or None
+
+    def subpages(self, pagename):
+
+        "Return the subpages of 'pagename'."
+
+        return []
+
+    # Page access methods.
+
+    def exists(self, pagename):
+
+        "Return whether 'pagename' exists."
+
+        return exists(self.to_filename(pagename))
+
+    def revision_exists(self, pagename, revision=None):
+
+        """
+        Return whether 'pagename' exists for 'revision', if specified, or the
+        recorded current revision otherwise.
+        """
+
+        return self.exists(pagename)
+
+    def readfile(self, filename, encoding=None):
+
+        """
+        Return the contents of the file having the given 'filename' and optional
+        'encoding'. This implementation treats 'filename' as a path.
+        """
+
+        return self.readpath(filename, encoding)
+
+    def read_revision(self, pagename, revision=None, encoding=None):
+
+        """
+        Return the contents of the file having the given 'pagename', 'revision',
+        and optional 'encoding'.
+        """
+
+        return self.readfile(self.to_filename(pagename), encoding)
+
+    # Input methods.
+
+    def readpath(self, filename, encoding=None):
+
+        """
+        Return the contents of the file having the given 'filename'. If the
+        optional 'encoding' is specified, override the general encoding.
+        """
+
+        return readfile(filename, encoding or self.encoding)
+
+    # Name translation methods.
+
+    def to_filename(self, pagename):
+
+        "Return the filename corresponding to 'pagename'."
+
+        return pagename
+
+    def to_pagename(self, filename):
+
+        "Return the pagename corresponding to 'filename'."
+
+        # Take the leafname as the pagename from an arbitrary filename.
+
+        return split(filename)[-1]
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/input/directory.py

@@ -0,0 +1,175 @@
+"""
+Directory input context.
+
+Copyright (C) 2018-2019, 2026 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from moinformat.input.common import Input
+from moinformat.utils.directory import Directory
+from os.path import join, sep
+
+
+class CommonDirectoryInput(Input):
+
+    "Common directory input functionality."
+
+    def __init__(self, metadata):
+
+        "Initialise the context with the given 'metadata'."
+
+        if "input_filename" not in metadata:
+            raise ValueError(metadata)
+
+        Input.__init__(self, metadata)
+        self.dir = Directory(metadata.get("input_filename"))
+
+        # Support attachments directories.
+
+        self.attachments_dir = metadata.get("attachments")
+
+        # Support a common attachments directory.
+
+        self.common_attachments = metadata.get("common_attachments")
+
+    def _get_attachments_dir(self, pagename):
+
+        "Return the attachments directory for 'pagename'."
+
+        if self.common_attachments:
+            return join(self.dir.filename, self.attachments_dir)
+        else:
+            return join(self.dir.filename, self.attachments_dir, pagename)
+
+    def all_attachments(self):
+
+        "Return all attachment filenames in the context."
+
+        return self.dir.select_files(join(self.attachments_dir, "*"), True)
+
+    def get_attachments(self, pagename):
+
+        """
+        Return all attachment filenames for the given 'pagename'. Each filename
+        is relative to the appropriate attachment directory.
+        """
+
+        return Directory(self._get_attachments_dir(pagename)).select_files("*")
+
+    # Page characteristics.
+
+    # def subpages(self, pagename):  # There us no subpage_filenames method in this class
+    #     "Return the subpages of 'pagename'."
+    #     return list(map(self.to_pagename, self.subpage_filenames(pagename)))
+
+
+    # Page access methods.
+
+    def exists(self, pagename):
+
+        "Return whether 'pagename' exists."
+
+        return self.dir.exists(self.to_filename(pagename))
+
+    def readfile(self, filename, encoding=None):
+
+        """
+        Return the contents of the file having the given 'filename' and optional
+        'encoding'.
+        """
+
+        return self.readpath(self.dir.get_filename(filename), encoding)
+
+    # Convenience methods.
+
+    def get_attachment_filename(self, pagename, filename):
+
+        """
+        Return the full path of an attachment file for the given 'pagename'
+        having the given 'filename'.
+        """
+
+        if not pagename:
+            return None
+
+        return self.dir.get_filename(join(self._get_attachments_dir(pagename),
+                                          filename))
+
+class DirectoryInput(CommonDirectoryInput):
+
+    "A directory input context."
+
+    name = "directory"
+
+    def __init__(self, metadata):
+
+        "Initialise the context with the given 'metadata'."
+
+        CommonDirectoryInput.__init__(self, metadata)
+
+        # Support an encoding of the level separator for the filesystem.
+        # Where it is the same as the directory separator, documents are stored
+        # using nested directories, not as a flat list.
+
+        self.level_sep = metadata.get("input_separator", sep)
+
+        # Search recursively in nested directories for pages.
+
+        self.nested = self.level_sep == sep
+
+    def all(self):
+
+        "Return all pages in the context."
+
+        # Ignore dotfiles.
+
+        return list(map(self.to_pagename, self.dir.select_files("[!.]*", self.nested)))
+
+    # Page characteristics.
+
+    def subpage_filenames(self, pagename):
+
+        "Return the subpage filenames of 'pagename'."
+
+        pattern = self.to_filename("%s%s*" % (pagename, self.level_sep))
+        return self.dir.select_files(pattern, self.nested)
+
+    def subpages(self, pagename):
+        "Return the subpages of 'pagename'."
+        return list(map(self.to_pagename, self.subpage_filenames(pagename)))
+
+    # NOTE: Translation methods should encode filenames appropriately.
+
+    def to_filename(self, pagename):
+
+        "Return the filename corresponding to 'pagename'."
+
+        if sep == self.level_sep:
+            return pagename
+        else:
+            return self.level_sep.join(pagename.split("/"))
+
+    def to_pagename(self, filename):
+
+        "Return the pagename corresponding to 'filename'."
+
+        if sep == self.level_sep:
+            return filename
+        else:
+            return "/".join(filename.split(self.level_sep))
+
+input = DirectoryInput
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/input/dummy.py

@@ -0,0 +1,64 @@
+"""Dummy input context."""
+#
+# Copyright (C) 2026 Morten Kjeldgaard <mok0@mailbox.org>
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# details.
+
+# You should have received a copy of the GNU General Public License along with
+# this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from moinformat.input.common import Input
+
+
+class DummyInput(Input):
+
+    "A dummy output context meant for testing."
+
+    name = "dummy"
+
+    def read(self, stream=None):
+        """Read from 'stream', or standard input if not specified,
+        returning a character string. This is a dummy reader, and it
+        accepts a stream, so in testing we can pass it a StringIO
+        object."""
+
+        if not stream:
+            return ""
+
+        return stream.read()
+
+    # Convenience methods.
+
+    def get_attachment_filename(self, _pagename, _filename):
+        """Prevent independent output by returning a filename of None
+        corresponding to the given 'pagename' and any specified
+        'filename'."""
+
+        return None
+
+    def exists(self, pagename: str):
+        """Return whether 'pagename´ exists, but this is a dummy
+        reader so yes it does."""
+
+        return True
+
+    def readpath(self, filename: str, encoding=None):
+        """This function is intended to return the contents of the
+        file having the given 'filename', but since this is a dummy
+        input meant for testing, we merely return the string passed in
+        `filename'."""
+
+        return filename
+
+
+input = DummyInput
+
+# vim: tabstop=4 expandtab shiftwidth=4

moinformat/input/manifest.py

@@ -0,0 +1,33 @@
+"""
+Input context implementation manifest.
+
+Copyright (C) 2017, 2018, 2021 Paul Boddie <paul@boddie.org.uk>
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 3 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+details.
+
+You should have received a copy of the GNU General Public License along with
+this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+
+from moinformat.imports import get_extensions, get_mapping, get_modules
+
+# Define an attribute mapping names to modules.
+
+modules = get_modules(__file__, __name__)
+
+# Obtain all input contexts.
+
+# Use names declared in each class to register the contexts:
+# input.name -> input
+
+inputs = get_mapping(modules, lambda n, m: [m.input.name], lambda m: m.input)
+
+# vim: tabstop=4 expandtab shiftwidth=4