Merge pull request #58 from Deric-W/Issueä57

Issue#57

Author: Deric-W

debian/postinst

@@ -4,7 +4,7 @@
 # postinst script which compiles python scripts
 
 if which py3compile >/dev/null 2>&1; then
-	py3compile -p python3-pyhp-core
+    py3compile -p python3-pyhp-core
 elif which python3 >/dev/null 2>&1; then
     python3 -m compileall -q /usr/lib/python3/dist-packages/pyhp
 fi

debian/prerm

@@ -5,17 +5,21 @@
 
 case "$1" in
     remove|upgrade|deconfigure)
-        # clear cache
-        set +e
-        pyhp-backend clear >/dev/null 2>&1
-        ret="$?"
-        set -e
-        case "$ret" in
-            0) echo "Info: PyHP backend is a cache and has been cleared";;
-            1) echo "Warning: Exception while clearing PyHP backend";;
-            3) echo "Info: PyHP backend is not a cache and has not been cleared";;
-            *) echo "Warning: Error while clearing PyHP backend";;
-        esac
+        # clear cache if toml module is installed
+        if which python3 >/dev/null 2>&1 && python3 -c "import toml" >/dev/null 2>&1; then
+            set +e
+            pyhp-backend clear >/dev/null 2>&1
+            ret="$?"
+            set -e
+            case "$ret" in
+                0) echo "Info: PyHP backend is a cache and has been cleared";;
+                1) echo "Warning: Exception while clearing PyHP backend";;
+                3) echo "Info: PyHP backend is not a cache and has not been cleared";;
+                *) echo "Warning: Error while clearing PyHP backend";;
+            esac
+        else
+            echo "Info: not clearing PyHP backend because python3-toml is not installed"
+        fi
 
         # remove __pycache__
         if which py3clean >/dev/null 2>&1; then

pyhp/__init__.py

@@ -24,5 +24,6 @@
     "compiler",
     "backends",
     "wsgi",
-    "main"
+    "main",
+    "config"
 )

pyhp/backends/main.py

@@ -19,7 +19,7 @@
 from typing import Callable, Union, Optional, Tuple, List, Iterable, TextIO
 import toml
 from .. import __version__
-from ..main import load_config
+from ..config import load_config
 from ..compiler import parsers, util
 from . import CodeSourceContainer, CodeSource, TimestampedCodeSource
 from .caches import CacheSource, CacheSourceContainer

pyhp/config.py

@@ -0,0 +1,44 @@
+#!/usr/bin/python3
+
+"""Module containing configuration utilities"""
+# The config module is part of PyHP (https://github.com/Deric-W/PyHP)
+# Copyright (C) 2021  Eric Wolf
+
+# 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, version 3.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+# SPDX-License-Identifier: GPL-3.0-only
+
+import os
+import os.path
+from typing import Any, Iterable, MutableMapping
+import toml
+
+__all__ = (
+    "CONFIG_LOCATIONS",
+    "load_config"
+)
+
+CONFIG_LOCATIONS = (
+    os.path.expanduser("~/.config/pyhp.toml"),
+    "/etc/pyhp.toml"
+)
+
+
+def load_config(search_paths: Iterable[str] = CONFIG_LOCATIONS) -> MutableMapping[str, Any]:
+    """locate and parse the config file"""
+    try:
+        path = os.environ["PYHPCONFIG"]
+    except KeyError:
+        pass
+    else:
+        return toml.load(path)
+    for path in search_paths:
+        try:
+            return toml.load(path)
+        except FileNotFoundError:
+            pass
+    raise RuntimeError("failed to locate the config file")

pyhp/main.py

@@ -13,28 +13,20 @@
 # SPDX-License-Identifier: GPL-3.0-only
 
 import sys
-import os
 import argparse
 from wsgiref.handlers import CGIHandler
-from typing import Any, Iterable, MutableMapping
 import toml
 from . import __version__
+from .config import load_config
 from .wsgi.apps import SimpleWSGIApp
 from .wsgi.util import SimpleWSGIAppFactory
 from .backends.memory import MemorySource
 
 
 __all__ = (
-    "CONFIG_LOCATIONS",
     "argparser",
     "cli_main",
-    "cgi_main",
-    "load_config"
-)
-
-CONFIG_LOCATIONS = (
-    os.path.expanduser("~/.config/pyhp.toml"),
-    "/etc/pyhp.toml"
+    "cgi_main"
 )
 
 argparser = argparse.ArgumentParser(
@@ -88,22 +80,6 @@ def handle_error(self) -> None:
         self.log_exception(sys.exc_info())
 
 
-def load_config(search_paths: Iterable[str] = CONFIG_LOCATIONS) -> MutableMapping[str, Any]:
-    """locate and parse the config file"""
-    try:
-        path = os.environ["PYHPCONFIG"]
-    except KeyError:
-        pass
-    else:
-        return toml.load(path)
-    for path in search_paths:
-        try:
-            return toml.load(path)
-        except FileNotFoundError:
-            pass
-    raise RuntimeError("failed to locate the config file")
-
-
 def cli_main() -> int:
     """cli entry point"""
     args = argparser.parse_args()

tests/test_config.py

@@ -0,0 +1,26 @@
+#!/usr/bin/python3
+
+"""Unit tests for pyhp.config"""
+
+import os
+import unittest
+import toml
+from pyhp import config
+
+
+class TestFunctions(unittest.TestCase):
+    """test free functions"""
+
+    def test_load_config(self) -> None:
+        """test load_config"""
+        with self.assertRaises(RuntimeError):   # no config
+            config.load_config()
+        os.environ["PYHPCONFIG"] = "pyhp.toml"  # env var
+        try:
+            self.assertEqual(config.load_config(), toml.load("pyhp.toml"))
+        finally:
+            del os.environ["PYHPCONFIG"]
+        self.assertEqual(                       # search path
+            config.load_config(("test1", "test2", "pyhp.toml")),
+            toml.load("pyhp.toml")
+        )

tests/test_main.py

@@ -8,7 +8,6 @@
 import unittest
 import unittest.mock
 import subprocess
-import toml
 from pyhp import main
 from pyhp.compiler import util, generic, parsers
 from pyhp.backends import CodeSourceContainer
@@ -50,20 +49,6 @@ def test_invalid_path(self) -> None:
                 stderr=subprocess.DEVNULL
             )
 
-    def test_config_location(self) -> None:
-        """test config file location"""
-        with self.assertRaises(RuntimeError):   # no config
-            main.load_config()
-        os.environ["PYHPCONFIG"] = "pyhp.toml"  # env var
-        try:
-            self.assertEqual(main.load_config(), toml.load("pyhp.toml"))
-        finally:
-            del os.environ["PYHPCONFIG"]
-        self.assertEqual(                       # search path
-            main.load_config(("test1", "test2", "pyhp.toml")),
-            toml.load("pyhp.toml")
-        )
-
     def test_cli_handler(self) -> None:
         """test CLIHandler"""
         args = main.argparser.parse_args(["test.pyhp", "-a", "b"])