Merge pull request #17 from volfpeter/fix/ignore-hidden-folders

Just log module import errors, skip folders whose name starts with a dot

Author: volfpeter

holm/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 
 from .app import App as App
 from .fastapi import FastAPIDependency as FastAPIDependency

holm/_model.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import logging
 from collections.abc import Callable
 from dataclasses import dataclass, field
 from importlib import import_module
@@ -137,7 +138,13 @@ def import_module(
 
         # Support applications that are not wrapped in a Python package.
         # In that case `self.package_name` is ".".
-        module = import_module(name if self.package_name == "." else f"{self.package_name}.{name}")
+        import_name = name if self.package_name == "." else f"{self.package_name}.{name}"
+        try:
+            module = import_module(import_name)
+        except Exception:
+            # Handle potential misconfigurations with a simple warning, instead of an exception.
+            logging.getLogger("holm").warning(f"Failed to import module {name} at: {import_name}")
+            return None
 
         if not validate(module):
             raise ValueError(f"Invalid module: {name}")

holm/app.py

@@ -137,18 +137,21 @@ def _discover_app_packages(config: AppConfig) -> set[PackageInfo]:
     @lru_cache()
     def is_excluded(path: Path) -> bool:
         """Returns whether the given file or package path should be excluded from the application."""
-        rel_path = path.relative_to(config.root_dir)
         return any(
             # Exclude if a path segment starts with an underscore but does not end with one.
             # Path segments that both start and end with an underscore represent path parameters!
-            p.startswith("_") and not p.endswith("_")
-            for p in rel_path.parts
+            (p.startswith("_") and not p.endswith("_"))
+            # Also exclude paths that start with a dot (virtual env, git, etc.)
+            or p.startswith(".")
+            for p in path.parts
         )
 
     return {
         PackageInfo.from_marker_file(f, config=config)
         for f in config.app_dir.rglob("*.py")
-        if f.stem in module_names and not is_excluded(f.parent)  # Pass the parent to make use of caching
+        if f.stem in module_names
+        # Pass the relative path of the parent to make the best use of caching
+        and not is_excluded(f.parent.relative_to(config.root_dir))
     }