Add error handling in ipypackagelayoutinfoprovider and its implementation, cache package names

Author: Aksem

extensions/fine_python_package_info/fine_python_package_info/py_package_layout_info_provider.py

@@ -3,42 +3,74 @@
 
 import tomlkit
 
-from finecode_extension_api.interfaces import ifilemanager, ipypackagelayoutinfoprovider
+from finecode_extension_api.interfaces import ifilemanager, ipypackagelayoutinfoprovider, icache
 from finecode_extension_api import service
 
 
+class ConfigParseError(Exception):
+    def __init__(self, message: str) -> None:
+        self.message = message
+
+
 class PyPackageLayoutInfoProvider(ipypackagelayoutinfoprovider.IPyPackageLayoutInfoProvider, service.Service):
-    def __init__(self, file_manager: ifilemanager.IFileManager) -> None:
+    PACKAGE_NAME_CACHE_KEY = 'PyPackageLayoutInfoProviderPackageName'
+
+    def __init__(self, file_manager: ifilemanager.IFileManager, cache: icache.ICache) -> None:
         self.file_manager = file_manager
-        # TODO: cache package name by file version?
+        self.cache = cache
 
     async def _get_package_name(self, package_dir_path: pathlib.Path) -> str:
+        # raises ConfigParseError
         package_def_file = package_dir_path / 'pyproject.toml'
         if not package_def_file.exists():
             raise NotImplementedError("Only python packages with pyproject.toml config file are supported")
 
+        try:
+            cached_package_name = await self.cache.get_file_cache(file_path=package_def_file, key=self.PACKAGE_NAME_CACHE_KEY)
+            return cached_package_name
+        except icache.CacheMissException:
+            ...
+
         package_def_file_content = await self.file_manager.get_content(file_path=package_def_file)
-        # TODO: handle errors
-        package_def_dict = tomlkit.loads(package_def_file_content)
+        package_def_file_version = await self.file_manager.get_file_version(file_path=package_def_file)
+        try:
+            package_def_dict = tomlkit.loads(package_def_file_content)
+        except tomlkit.exceptions.ParseError as exception:
+            raise ConfigParseError(f"Failed to parse package config {package_def_file}: {exception.message} at {exception.line}:{exception.col}")
+
         package_raw_name = package_def_dict.get('project', {}).get('name', None)
         if package_raw_name is None:
             raise ValueError(f"package.name not found in {package_def_file}")
 
-        return package_raw_name.replace('-', '_')
+        package_name = package_raw_name.replace('-', '_')
+        await self.cache.save_file_cache(file_path=package_def_file, file_version=package_def_file_version, key=self.PACKAGE_NAME_CACHE_KEY, value=package_name)
+        return package_name
 
     async def get_package_layout(self, package_dir_path: pathlib.Path) -> ipypackagelayoutinfoprovider.PyPackageLayout:
         if (package_dir_path / 'src').exists():
             return ipypackagelayoutinfoprovider.PyPackageLayout.SRC
         else:
-            package_name = await self._get_package_name(package_dir_path=package_dir_path)
+            try:
+                package_name = await self._get_package_name(package_dir_path=package_dir_path)
+            except ConfigParseError as exception:
+                raise ipypackagelayoutinfoprovider.FailedToGetPackageLayout(exception.message)
+            
             if (package_dir_path / package_name).exists():
                 return ipypackagelayoutinfoprovider.PyPackageLayout.FLAT
             else:
                 return ipypackagelayoutinfoprovider.PyPackageLayout.CUSTOM
 
     async def get_package_src_root_dir_path(self, package_dir_path: str) -> pathlib.Path:
-        package_layout = await self.get_package_layout(package_dir_path=package_dir_path)
-        package_name = await self._get_package_name(package_dir_path=package_dir_path)
+        try:
+            package_layout = await self.get_package_layout(package_dir_path=package_dir_path)
+        except ipypackagelayoutinfoprovider.FailedToGetPackageLayout as exception:
+            raise ipypackagelayoutinfoprovider.FailedToGetPackageSrcRootDirPath(exception.message)
+
+        try:
+            package_name = await self._get_package_name(package_dir_path=package_dir_path)
+        except ConfigParseError as exception:
+            raise ipypackagelayoutinfoprovider.FailedToGetPackageSrcRootDirPath(exception.message)
+
         if package_layout == ipypackagelayoutinfoprovider.PyPackageLayout.SRC:
             return package_dir_path / 'src' / package_name
         elif package_layout == ipypackagelayoutinfoprovider.PyPackageLayout.FLAT:

finecode_extension_api/src/finecode_extension_api/actions/list_project_files_by_lang.py

@@ -1,7 +1,6 @@
 import dataclasses
 import pathlib
 import sys
-import typing
 
 if sys.version_info >= (3, 12):
     from typing import override

finecode_extension_api/src/finecode_extension_api/interfaces/ipypackagelayoutinfoprovider.py

@@ -21,3 +21,13 @@ async def get_package_src_root_dir_path(
         # if you need path to directory which is added to sys.path during execution, take
         # parent of this directory.
         ...
+
+
+class FailedToGetPackageLayout(Exception):
+    def __init__(self, message: str) -> None:
+        self.message = message
+
+
+class FailedToGetPackageSrcRootDirPath(Exception):
+    def __init__(self, message: str) -> None:
+        self.message = message

finecode_extension_runner/src/finecode_extension_runner/di/bootstrap.py

@@ -170,6 +170,7 @@ async def project_file_classifier_factory(
 
 async def py_package_layout_info_provider_factory(container):
     file_manager = await resolver.get_service_instance(ifilemanager.IFileManager)
+    cache = await resolver.get_service_instance(icache.ICache)
     return fine_python_package_info.PyPackageLayoutInfoProvider(
-        file_manager=file_manager,
+        file_manager=file_manager, cache=cache
     )