Find python files in project using new list_project_files_by_lang action instead of rglobbing. Fix repeating lint messages in IDE (cached result of first handler was modified without copying). Restructure WM services to avoid cycle imports.

Author: Aksem

extensions/fine_python_package_info/README.md

@@ -0,0 +1,7 @@
+from .list_project_files_by_lang_python import ListProjectFilesByLangPythonHandler
+from .py_package_layout_info_provider import PyPackageLayoutInfoProvider
+
+__all__ = [
+    "ListProjectFilesByLangPythonHandler",
+    "PyPackageLayoutInfoProvider"
+]

extensions/fine_python_package_info/fine_python_package_info/__init__.py

@@ -0,0 +1,48 @@
+from finecode_extension_api.interfaces import iprojectinfoprovider, ipypackagelayoutinfoprovider
+import dataclasses
+import pathlib
+
+from finecode_extension_api import code_action
+from finecode_extension_api.actions import list_project_files_by_lang as list_project_files_by_lang_action
+
+
+@dataclasses.dataclass
+class ListProjectFilesByLangPythonHandlerConfig(code_action.ActionHandlerConfig): ...
+# TODO: parameter for additional dirs
+
+
+class ListProjectFilesByLangPythonHandler(
+    code_action.ActionHandler[
+        list_project_files_by_lang_action.ListProjectFilesByLangAction, ListProjectFilesByLangPythonHandlerConfig
+    ]
+):
+    def __init__(self, project_info_provider: iprojectinfoprovider.IProjectInfoProvider, py_package_layout_info_provider: ipypackagelayoutinfoprovider.IPyPackageLayoutInfoProvider) -> None:
+        self.project_info_provider = project_info_provider
+        self.py_package_layout_info_provider = py_package_layout_info_provider
+
+        self.current_project_dir_path = self.project_info_provider.get_current_project_dir_path()
+        self.tests_dir_path = self.current_project_dir_path / 'tests'
+        self.scripts_dir_path = self.current_project_dir_path / 'scripts'
+        self.setup_py_path = self.current_project_dir_path / 'setup.py'
+
+    async def run(
+        self,
+        payload: list_project_files_by_lang_action.ListProjectFilesByLangRunPayload,
+        run_context: list_project_files_by_lang_action.ListProjectFilesByLangRunContext,
+    ) -> list_project_files_by_lang_action.ListProjectFilesByLangRunResult:
+        py_files: list[pathlib.Path] = []
+        project_package_src_root_dir_path = await self.py_package_layout_info_provider.get_package_src_root_dir_path(package_dir_path=self.current_project_dir_path)
+        py_files += list(project_package_src_root_dir_path.rglob('*.py'))
+
+        if self.scripts_dir_path.exists():
+            py_files += list(self.scripts_dir_path.rglob('*.py'))
+        
+        if self.tests_dir_path.exists():
+            py_files += list(self.tests_dir_path.rglob('*.py'))
+
+        if self.setup_py_path.exists():
+            py_files.append(self.setup_py_path)
+
+        return list_project_files_by_lang_action.ListProjectFilesByLangRunResult(
+            files_by_lang={"python": py_files}
+        )

extensions/fine_python_package_info/fine_python_package_info/list_project_files_by_lang_python.py

@@ -0,0 +1,47 @@
+import enum
+import pathlib
+
+import tomlkit
+
+from finecode_extension_api.interfaces import ifilemanager, ipypackagelayoutinfoprovider
+from finecode_extension_api import service
+
+
+class PyPackageLayoutInfoProvider(ipypackagelayoutinfoprovider.IPyPackageLayoutInfoProvider, service.Service):
+    def __init__(self, file_manager: ifilemanager.IFileManager) -> None:
+        self.file_manager = file_manager
+        # TODO: cache package name by file version?
+
+    async def _get_package_name(self, package_dir_path: pathlib.Path) -> str:
+        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")
+
+        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_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('-', '_')
+
+    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)
+            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)
+        if package_layout == ipypackagelayoutinfoprovider.PyPackageLayout.SRC:
+            return package_dir_path / 'src' / package_name
+        elif package_layout == ipypackagelayoutinfoprovider.PyPackageLayout.FLAT:
+            return package_dir_path / package_name
+        else:
+            raise NotImplementedError(f"Custom python package layout in {package_dir_path} is not supported")

extensions/fine_python_package_info/fine_python_package_info/py_package_layout_info_provider.py

@@ -0,0 +1,8 @@
+[project]
+name = "fine_python_package_info"
+version = "0.1.0"
+description = ""
+authors = [{ name = "Vladyslav Hnatiuk", email = "[email protected]" }]
+readme = "README.md"
+requires-python = ">=3.11, < 3.14"
+dependencies = ["finecode_extension_api==0.3.*", "tomlkit==0.11.*"]

extensions/fine_python_package_info/pyproject.toml

@@ -0,0 +1,67 @@
+import atexit
+import shutil
+import sys
+import tempfile
+
+from setuptools import setup
+from setuptools.command.build import build
+from setuptools.command.build_ext import build_ext
+from setuptools.command.build_py import build_py
+from setuptools.command.egg_info import egg_info
+
+# Create a single temp directory for all build operations
+_TEMP_BUILD_DIR = None
+
+
+def get_temp_build_dir(pkg_name):
+    global _TEMP_BUILD_DIR
+    if _TEMP_BUILD_DIR is None:
+        _TEMP_BUILD_DIR = tempfile.mkdtemp(prefix=f"{pkg_name}_build_")
+        atexit.register(lambda: shutil.rmtree(_TEMP_BUILD_DIR, ignore_errors=True))
+    return _TEMP_BUILD_DIR
+
+
+class TempDirBuildMixin:
+    def initialize_options(self):
+        super().initialize_options()
+        temp_dir = get_temp_build_dir(self.distribution.get_name())
+        self.build_base = temp_dir
+
+
+class TempDirEggInfoMixin:
+    def initialize_options(self):
+        super().initialize_options()
+        temp_dir = get_temp_build_dir(self.distribution.get_name())
+        self.egg_base = temp_dir
+
+
+class CustomBuild(TempDirBuildMixin, build):
+    pass
+
+
+class CustomBuildPy(TempDirBuildMixin, build_py):
+    pass
+
+
+class CustomBuildExt(TempDirBuildMixin, build_ext):
+    pass
+
+
+class CustomEggInfo(TempDirEggInfoMixin, egg_info):
+    def initialize_options(self):
+        # Don't use temp dir for editable installs
+        if "--editable" in sys.argv or "-e" in sys.argv:
+            egg_info.initialize_options(self)
+        else:
+            super().initialize_options()
+
+
+setup(
+    name="fine_python_package_info",
+    cmdclass={
+        "build": CustomBuild,
+        "build_py": CustomBuildPy,
+        "build_ext": CustomBuildExt,
+        "egg_info": CustomEggInfo,
+    },
+)

extensions/fine_python_package_info/setup.py

@@ -0,0 +1 @@
+# Tests for fine_python_package_info extension

extensions/fine_python_package_info/tests/__init__.py

@@ -9,6 +9,7 @@
 from setuptools.command.build_py import build_py
 from setuptools.command.egg_info import egg_info
 
+
 # Create a single temp directory for all build operations
 _TEMP_BUILD_DIR = None
 

extensions/fine_python_pip/setup.py

@@ -37,7 +37,6 @@ def __init__(
         command_runner: icommandrunner.ICommandRunner,
     ) -> None:
         self.config = config
-        self.context = context
         self.logger = logger
         self.cache = cache
         self.command_runner = command_runner

extensions/fine_python_ruff/fine_python_ruff/format_handler.py

@@ -16,4 +16,4 @@
     "PrepareRunnersInstallRunnerAndPresetsHandler",
     "PrepareRunnersReadConfigsHandler",
     "DumpConfigSaveHandler",
-]
+]