add sample settings.py module

Author: edublancas

src/pkgmt/assets/template/pyproject-setup.toml

@@ -34,7 +34,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "$project_name"
-version = "0.0.1"
+version = "0.1dev"
 description = "A sample Python project"
 readme = "README.md"
 requires-python = ">=3.9"

src/pkgmt/assets/template/settings.py

@@ -0,0 +1,14 @@
+# import os
+from pathlib import Path
+
+# from dotenv import load_dotenv
+
+# load_dotenv()
+
+path_to_home = Path.home()
+
+PATH_TO_PROJECT_ROOT = Path(__file__).parent
+
+# PATH_TO_DB = path_to_home / "data" / "db.sqlite"
+# LOCAL_DB_URI = f"sqlite:///{PATH_TO_DB}"
+# OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")

src/pkgmt/assets/template/src/package_name/__init__.py

@@ -1 +1,6 @@
+# flake8: noqa
+from $package_name._settings import Settings
+
+SETTINGS = Settings()
+
 __version__ = "0.1dev"

src/pkgmt/assets/template/src/package_name/_settings.py

@@ -0,0 +1,160 @@
+from pathlib import Path
+import sys
+from copy import copy
+from inspect import getmembers
+import importlib
+import os
+from contextlib import contextmanager
+
+
+@contextmanager
+def add_to_sys_path(path):
+    """Add the given path to sys.path for the duration of the context"""
+    path = os.path.abspath(path)
+    sys.path.insert(0, path)
+
+    try:
+        yield
+    finally:
+        sys.path.remove(path)
+
+
+class BaseSchema:
+    """A base object to define a schema for settings validation"""
+
+    @staticmethod
+    def _get_public_attributes(obj):
+        return {k.upper(): v for k, v in obj.__dict__.items() if not k.startswith("_")}
+
+    @classmethod
+    def _validate(cls, settings):
+        validators = cls._get_public_attributes(cls)
+        validators_docs = {k: v.__doc__ for k, v in validators.items()}
+
+        missing = sorted(set(validators) - set(settings))
+
+        if missing:
+            missing_with_docs = {
+                k: v for k, v in validators_docs.items() if k in missing
+            }
+
+            formatted_error = "\n".join(
+                [f"{k}: {v}" for k, v in missing_with_docs.items()]
+            )
+
+            raise RuntimeError(
+                f"Error validating settings, missing:\n\n{formatted_error}"
+            )
+
+        unexpected = sorted(set(settings) - set(validators))
+
+        if unexpected:
+            formatted_error = "\n".join([k for k in unexpected])
+
+            raise RuntimeError(
+                f"Error validating settings, unexpected:\n\n{formatted_error}"
+            )
+
+        matched = set(validators) & set(settings)
+
+        for match in matched:
+            try:
+                validators[match](settings[match])
+            except Exception as e:
+                raise RuntimeError(
+                    f"Error validating settings, the validator for {match} "
+                    f"failed: {str(e)}"
+                ) from e
+
+
+class Schema(BaseSchema):
+    """The schema that validates the settings
+
+    Notes
+    -----
+    To register a new setting, add a new method to this class. The method name
+    must match the setting name in uppercase. The method docstring will be
+    used to display the error message if the setting is missing or invalid.
+    The body of the function can raise exceptions to validate the setting.
+    """
+
+    @staticmethod
+    def path_to_project_root(value):
+        """The path to project root"""
+        pass
+
+
+class BaseSettings:
+    """A base object to load settings from a settings.py file"""
+
+    SCHEMA = None
+
+    def __init__(self) -> None:
+        self._path_to_settings, _ = find_file_recursively("settings.py")
+        self._load()
+
+    def _load(self):
+        with add_to_sys_path(self._path_to_settings.parent):
+            module = importlib.import_module("settings")
+
+        del sys.modules["settings"]
+
+        self._settings = {k: v for k, v in getmembers(module) if k.upper() == k}
+        self.SCHEMA._validate(self._settings)
+
+        for k, v in self._settings.items():
+            setattr(self, k, v)
+
+    def to_dict(self):
+        return copy(self._settings)
+
+    def to_environ(self):
+        """Set all settings as environment variables"""
+        for k, v in self.to_dict().items():
+            os.environ[k] = str(v)
+
+
+class Settings(BaseSettings):
+    """
+    The settings object used to load settings from settings.py. It validates
+    with the Schema class
+    """
+
+    SCHEMA = Schema
+
+
+def find_file_recursively(name, max_levels_up=6, starting_dir=None):
+    """
+    Find a file by looking into the current folder and parent folders,
+    returns None if no file was found otherwise pathlib.Path to the file
+
+    Parameters
+    ----------
+    name : str
+        Filename
+
+    Returns
+    -------
+    path : str
+        Absolute path to the file
+    levels : int
+        How many levels up the file is located
+    """
+    current_dir = starting_dir or os.getcwd()
+    current_dir = Path(current_dir).resolve()
+    path_to_file = None
+    levels = None
+
+    for levels in range(max_levels_up):
+        current_path = Path(current_dir, name)
+
+        if current_path.exists():
+            path_to_file = current_path.resolve()
+            break
+
+        current_dir = current_dir.parent
+
+    if not path_to_file:
+        raise FileNotFoundError(f"File {name} not found")
+
+    return path_to_file, levels

src/pkgmt/new.py

@@ -3,7 +3,7 @@
 import shutil
 import importlib.resources
 from string import Template
-
+import re
 from pkgmt import assets
 
 
@@ -36,6 +36,7 @@ def package(name, use_setup_py=False):
         ".github/workflows/ci.yml",
         "src/package_name/cli.py",
         "src/package_name/log.py",
+        "src/package_name/__init__.py",
     ):
         render_inplace(
             root / file,
@@ -52,7 +53,14 @@ def package(name, use_setup_py=False):
         (root / "setup.py").unlink()
         (root / "MANIFEST.in").unlink()
         (root / "pyproject-setup.toml").rename(root / "pyproject.toml")
-        (root / "src" / package_name / "__init__.py").write_text("")
+
+        # Remove __version__ from __init__.py
+        content = (root / "src" / package_name / "__init__.py").read_text()
+        lines = content.splitlines()
+        new_lines = [
+            line for line in lines if not re.match(r"__version__\s+=\s+", line)
+        ]
+        (root / "src" / package_name / "__init__.py").write_text("\n".join(new_lines))
 
     # Remove flake8: noqa comments from Python files, we added them because
     # they contain $TAG, which raises a warning when linting

tests/test_new.py

@@ -2,6 +2,8 @@
 from unittest.mock import ANY
 from pathlib import Path
 import subprocess
+import os
+
 from pkgmt import new
 
 import pytest
@@ -16,15 +18,17 @@ def uninstall():
 def test_package_setup_py(tmp_empty, uninstall):
     new.package("some-cool_pkg", use_setup_py=True)
 
-    subprocess.check_call(["pip", "install", "some-cool-pkg/"])
-
-    pyproject = Path("some-cool-pkg", "pyproject.toml").read_text()
-    setup = Path("some-cool-pkg", "setup.py").read_text()
-    ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
-    manifest = Path("some-cool-pkg", "MANIFEST.in").read_text()
-    init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
-    cli = Path("some-cool-pkg", "src", "some_cool_pkg", "cli.py").read_text()
-    assert '__version__ = "0.1dev"\n' == init
+    # move the working directory so the settings.py file is found
+    os.chdir("some-cool-pkg")
+    subprocess.check_call(["pip", "install", "."])
+
+    pyproject = Path("pyproject.toml").read_text()
+    setup = Path("setup.py").read_text()
+    ci = Path(".github", "workflows", "ci.yml").read_text()
+    manifest = Path("MANIFEST.in").read_text()
+    init = Path("src", "some_cool_pkg", "__init__.py").read_text()
+    cli = Path("src", "some_cool_pkg", "cli.py").read_text()
+    assert '__version__ = "0.1dev"\n' in init
     assert 'github = "ploomber/some-cool-pkg"' in pyproject
     assert 'package_name = "some_cool_pkg"' in pyproject
     assert 'env_name = "some-cool-pkg"' in pyproject
@@ -46,17 +50,19 @@ def test_package_setup_py(tmp_empty, uninstall):
 def test_package_pyproject_toml(tmp_empty, uninstall):
     new.package("some-cool_pkg", use_setup_py=False)
 
-    subprocess.check_call(["pip", "install", "some-cool-pkg/"])
+    # move the working directory so the settings.py file is found
+    os.chdir("some-cool-pkg")
+    subprocess.check_call(["pip", "install", "."])
 
-    pyproject = Path("some-cool-pkg", "pyproject.toml").read_text()
-    ci = Path("some-cool-pkg", ".github", "workflows", "ci.yml").read_text()
-    init = Path("some-cool-pkg", "src", "some_cool_pkg", "__init__.py").read_text()
-    cli = Path("some-cool-pkg", "src", "some_cool_pkg", "cli.py").read_text()
-    assert not Path("some-cool-pkg", "setup.py").exists()
-    assert not Path("some-cool-pkg", "MANIFEST.in").exists()
-    assert not Path("some-cool-pkg", "pyproject-setup.toml").exists()
+    pyproject = Path("pyproject.toml").read_text()
+    ci = Path(".github", "workflows", "ci.yml").read_text()
+    init = Path("src", "some_cool_pkg", "__init__.py").read_text()
+    cli = Path("src", "some_cool_pkg", "cli.py").read_text()
+    assert not Path("setup.py").exists()
+    assert not Path("MANIFEST.in").exists()
+    assert not Path("pyproject-setup.toml").exists()
 
-    assert init == "\n"
+    assert "__version__" not in init
 
     assert 'github = "ploomber/some-cool-pkg"' in pyproject
     assert 'package_name = "some_cool_pkg"' in pyproject