basic support for uv env & package manager; PY-75983

GitOrigin-RevId: 2597e4de17e167d8a0b0038190b5127a9dc4b155
JetBrains · Nov 15, 2024 · 9b76b13 · 9b76b13
1 parent 6de9588
commit 9b76b13
Show file tree

Hide file tree

Showing 26 changed files with 976 additions and 46 deletions.
diff --git a/python/intellij.python.community.impl.iml b/python/intellij.python.community.impl.iml
@@ -157,5 +157,6 @@
     <orderEntry type="library" name="kotlinx-datetime-jvm" level="project" />
     <orderEntry type="module" module-name="intellij.platform.ide.remote" />
     <orderEntry type="module" module-name="intellij.platform.ide.ui" />
+    <orderEntry type="library" name="jackson-module-kotlin" level="project" />
   </component>
 </module>
diff --git a/python/pluginCore/resources/META-INF/plugin.xml b/python/pluginCore/resources/META-INF/plugin.xml
@@ -59,6 +59,7 @@ The Python plug-in provides smart editing for Python scripts. The feature set of
 
   <extensions defaultExtensionNs="com.intellij">
     <localInspection language="TOML" enabledByDefault="true" implementationClass="com.jetbrains.python.sdk.poetry.PoetryPackageVersionsInspection" key="INSP.poetry.package.versions.display.name" bundle="messages.PyBundle" groupKey="INSP.GROUP.python" suppressId="PoetryPackageVersions" shortName="PoetryPackageVersionsInspection"/>
+    <localInspection language="TOML" enabledByDefault="true" implementationClass="com.jetbrains.python.sdk.uv.UvPackageVersionsInspection" key="INSP.poetry.package.versions.display.name" bundle="messages.PyBundle" groupKey="INSP.GROUP.python" suppressId="UvPackageVersions" shortName="UvPackageVersionsInspection"/>
 
     <fileType name="Requirements.txt"
               implementationClass="com.jetbrains.python.requirements.RequirementsFileType"
@@ -830,6 +831,8 @@ The Python plug-in provides smart editing for Python scripts. The feature set of
     <pyAddSdkProvider implementation="com.jetbrains.python.sdk.poetry.PyAddPoetrySdkProvider"/>
     <pythonFlavorProvider implementation="com.jetbrains.python.sdk.poetry.PyPoetrySdkFlavorProvider"/>
 
+    <pythonFlavorProvider implementation="com.jetbrains.python.sdk.uv.UvSdkFlavorProvider"/>
+
     <!-- SDK Flavors -->
     <pythonSdkFlavor implementation="com.jetbrains.python.sdk.flavors.conda.CondaEnvSdkFlavor"/>
     <pythonSdkFlavor implementation="com.jetbrains.python.sdk.flavors.JythonSdkFlavor"/>
@@ -858,6 +861,8 @@ The Python plug-in provides smart editing for Python scripts. The feature set of
     <packageManagerProvider implementation="com.jetbrains.python.sdk.poetry.PyPoetryPackageManagerProvider"/>
     <pythonPackageManagerProvider implementation="com.jetbrains.python.sdk.poetry.PoetryPackageManagerProvider"/>
 
+    <pySdkProvider implementation="com.jetbrains.python.sdk.uv.UvSdkProvider"/>
+    <pythonPackageManagerProvider implementation="com.jetbrains.python.sdk.uv.UvPackageManagerProvider"/>
 
     <pythonPackageManagerProvider implementation="com.jetbrains.python.packaging.pip.PipPackageManagerProvider" order="last"/>
     <pythonPackageManagerProvider implementation="com.jetbrains.python.packaging.conda.CondaPackageManagerProvider"/>

diff --git a/python/pluginResources/inspectionDescriptions/UvPackageVersionsInspection.html b/python/pluginResources/inspectionDescriptions/UvPackageVersionsInspection.html
@@ -0,0 +1,7 @@
+<html>
+<body>
+<p>Reports outdated versions of packages in <code>[dependencies]</code> and <code>[dev-dependencies]</code>
+  sections of <code>pyproject.toml</code>.
+</p>
+</body>
+</html>
diff --git a/python/pluginResources/inspectionDescriptions/metaInformation.json b/python/pluginResources/inspectionDescriptions/metaInformation.json
@@ -12,6 +12,10 @@
       "id": "PoetryPackageVersionsInspection",
       "codeQualityCategory": "Sanity"
     },
+    {
+      "id": "UvPackageVersionsInspection",
+      "codeQualityCategory": "Sanity"
+    },
     {
       "id": "PyStubPackagesCompatibilityInspection",
       "codeQualityCategory": "Sanity"

diff --git a/python/pluginResources/messages/PyBundle.properties b/python/pluginResources/messages/PyBundle.properties
@@ -273,7 +273,7 @@ python.console=Python Console
 python.console.history.root=Python Consoles
 python.console.run.anything.provider=Runs Python Console
 python.console.not.supported=Python console for {0} interpreter is not supported
-python.console.toolbar.action.available.non.interactive=The action is not available for non-interactive shell 
+python.console.toolbar.action.available.non.interactive=The action is not available for non-interactive shell
 
 runcfg.unittest.dlg.test_function_title=Function
 run.configuration.remote.debug.name=Python Remote Debug
@@ -395,6 +395,20 @@ python.sdk.poetry.install.packages.from.toml.checkbox.text=Install packages from
 python.sdk.poetry.dialog.message.poetry.interpreter.has.been.already.added=Poetry interpreter has been already added, select ''{0}''
 python.sdk.poetry.dialog.add.new.environment.in.project.checkbox=Create an in-project environment
 
+# UV
+python.sdk.dialog.message.creating.virtual.environments.based.on.uv.environments.not.supported=Creating virtual environments based on UV environments is not supported
+python.sdk.dialog.title.setting.up.uv.environment=Setting up UV environment
+python.sdk.inspection.message.uv.interpreter.associated.with.another.project=Uv interpreter is associated with another {0}: {1}
+python.sdk.inspection.message.uv.interpreter.not.associated.with.any.project=Uv interpreter is not associated with any {0}
+python.sdk.intention.family.name.install.requirements.from.uv.lock=Install requirements from uv.lock
+python.sdk.quickfix.use.uv.name=Use UV interpreter
+python.sdk.uv.associated.module=Associated module:
+python.sdk.uv.associated.project=Associated project:
+python.sdk.uv.environment.panel.title=Uv Environment
+python.sdk.uv.executable.not.found=UV executable is not found
+python.sdk.uv.executable=Uv executable:
+python.sdk.uv.install.packages.from.toml.checkbox.text=Install packages from pyproject.toml
+
 python.sdk.pipenv.has.been.selected=Pipenv interpreter has been already added, select ''{0}'' in your interpreters list
 python.sdk.there.is.no.interpreter=No interpreter
 python.sdk.no.interpreter.configured.warning=No Python interpreter configured for the project
@@ -541,6 +555,7 @@ sdk.create.custom.virtualenv=Virtualenv
 sdk.create.custom.conda=Conda
 sdk.create.custom.pipenv=Pipenv
 sdk.create.custom.poetry=Poetry
+sdk.create.custom.uv=Uv
 sdk.create.custom.python=Python
 
 sdk.rendering.detected.grey.text=detected in the system

diff --git a/python/src/com/jetbrains/python/packaging/common/packages.kt b/python/src/com/jetbrains/python/packaging/common/packages.kt
@@ -31,6 +31,10 @@ open class PythonPackage(val name: String, val version: String, val isEditableMo
   }
 }
 
+open class PythonOutdatedPackage(name: String, version: String, isEditableMode: Boolean, val latestVersion: String)
+  : PythonPackage(name, version, isEditableMode)
+{}
+
 interface PythonPackageDetails {
 
   val name: String

diff --git a/python/src/com/jetbrains/python/sdk/add/v2/CustomNewEnvironmentCreator.kt b/python/src/com/jetbrains/python/sdk/add/v2/CustomNewEnvironmentCreator.kt
@@ -66,9 +66,13 @@ abstract class CustomNewEnvironmentCreator(private val name: String, model: Pyth
                              ProjectJdkTable.getInstance().allJdks.asList(),
                              model.myProjectPathFlows.projectPathWithDefault.first().toString(),
                              homePath,
-                             false).getOrElse { return Result.failure(it) }
+                             false)
+      .getOrElse { return Result.failure(it) }
     newSdk.persist()
+
+    module?.excludeInnerVirtualEnv(newSdk)
     model.addInterpreter(newSdk)
+
     return Result.success(newSdk)
   }
 

diff --git a/...sdk/add/v2/PipEnvNewEnvironmentCreator.kt → ...ython/sdk/add/v2/EnvironmentCreatorPip.kt b/...sdk/add/v2/PipEnvNewEnvironmentCreator.kt → ...ython/sdk/add/v2/EnvironmentCreatorPip.kt
@@ -13,7 +13,7 @@ import com.jetbrains.python.statistics.InterpreterType
 import java.nio.file.Path
 
 
-class PipEnvNewEnvironmentCreator(model: PythonMutableTargetAddInterpreterModel) : CustomNewEnvironmentCreator("pipenv", model) {
+class EnvironmentCreatorPip(model: PythonMutableTargetAddInterpreterModel) : CustomNewEnvironmentCreator("pipenv", model) {
   override val interpreterType: InterpreterType = InterpreterType.PIPENV
   override val executable: ObservableMutableProperty<String> = model.state.pipenvExecutable
   override val installationScript: Path? = null

diff --git a/...sdk/add/v2/PoetryNewEnvironmentCreator.kt → ...on/sdk/add/v2/EnvironmentCreatorPoetry.kt b/...sdk/add/v2/PoetryNewEnvironmentCreator.kt → ...on/sdk/add/v2/EnvironmentCreatorPoetry.kt
@@ -34,7 +34,7 @@ import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.withContext
 import java.nio.file.Path
 
-class PoetryNewEnvironmentCreator(model: PythonMutableTargetAddInterpreterModel, private val moduleOrProject: ModuleOrProject?) : CustomNewEnvironmentCreator("poetry", model) {
+class EnvironmentCreatorPoetry(model: PythonMutableTargetAddInterpreterModel, private val moduleOrProject: ModuleOrProject?) : CustomNewEnvironmentCreator("poetry", model) {
   override val interpreterType: InterpreterType = InterpreterType.POETRY
   override val executable: ObservableMutableProperty<String> = model.state.poetryExecutable
   override val installationScript = PythonHelpersLocator.findPathInHelpers("pycharm_poetry_installer.py")

diff --git a/python/src/com/jetbrains/python/sdk/add/v2/EnvironmentCreatorUv.kt b/python/src/com/jetbrains/python/sdk/add/v2/EnvironmentCreatorUv.kt
@@ -0,0 +1,43 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package com.jetbrains.python.sdk.add.v2
+
+import com.intellij.ide.util.PropertiesComponent
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.observable.properties.ObservableMutableProperty
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.projectRoots.Sdk
+import com.jetbrains.python.sdk.ModuleOrProject
+import com.jetbrains.python.sdk.uv.uvPath
+import com.jetbrains.python.sdk.uv.setupUvSdkUnderProgress
+import com.jetbrains.python.statistics.InterpreterType
+import java.nio.file.Path
+
+class EnvironmentCreatorUv(model: PythonMutableTargetAddInterpreterModel, private val moduleOrProject: ModuleOrProject?) : CustomNewEnvironmentCreator("uv", model) {
+  override val interpreterType: InterpreterType = InterpreterType.UV
+  override val executable: ObservableMutableProperty<String> = model.state.uvExecutable
+  // FIXME: support uv installation
+  override val installationScript = null
+
+  override fun onShown() {
+    // FIXME: validate base interpreters against pyprojecttoml version. See poetry
+    basePythonComboBox.setItems(model.baseInterpreters)
+  }
+
+  override fun savePathToExecutableToProperties() {
+    PropertiesComponent.getInstance().uvPath = Path.of(executable.get())
+  }
+
+  override suspend fun setupEnvSdk(project: Project?, module: Module?, baseSdks: List<Sdk>, projectPath: String, homePath: String?, installPackages: Boolean): Result<Sdk> {
+    if (module == null) {
+      // FIXME: should not happen, proper error
+      return Result.failure(Exception("module is null"))
+    }
+
+    val python = homePath?.let { Path.of(it) }
+    return setupUvSdkUnderProgress(module, Path.of(projectPath), baseSdks, python)
+  }
+
+  override suspend fun detectExecutable() {
+    model.detectUvExecutable()
+  }
+}
diff --git a/.../sdk/add/v2/PythonNewVirtualenvCreator.kt → ...thon/sdk/add/v2/EnvironmentCreatorVenv.kt b/.../sdk/add/v2/PythonNewVirtualenvCreator.kt → ...thon/sdk/add/v2/EnvironmentCreatorVenv.kt
@@ -36,7 +36,7 @@ import java.nio.file.Paths
 import kotlin.io.path.exists
 import kotlin.io.path.isDirectory
 
-class PythonNewVirtualenvCreator(model: PythonMutableTargetAddInterpreterModel) : PythonNewEnvironmentCreator(model) {
+class EnvironmentCreatorVenv(model: PythonMutableTargetAddInterpreterModel) : PythonNewEnvironmentCreator(model) {
   private lateinit var versionComboBox: PythonInterpreterComboBox
 
   private val locationValidationFailed = propertyGraph.property(false)

diff --git a/python/src/com/jetbrains/python/sdk/add/v2/PythonAddCustomInterpreter.kt b/python/src/com/jetbrains/python/sdk/add/v2/PythonAddCustomInterpreter.kt
@@ -27,10 +27,11 @@ class PythonAddCustomInterpreter(val model: PythonMutableTargetAddInterpreterMod
   private val existingInterpreterManager = propertyGraph.property(PYTHON)
 
   private val newInterpreterCreators = mapOf(
-    VIRTUALENV to PythonNewVirtualenvCreator(model),
-    CONDA to CondaNewEnvironmentCreator(model,  errorSink),
-    PIPENV to PipEnvNewEnvironmentCreator(model),
-    POETRY to PoetryNewEnvironmentCreator(model, moduleOrProject),
+    VIRTUALENV to EnvironmentCreatorVenv(model),
+    CONDA to CondaNewEnvironmentCreator(model, errorSink),
+    PIPENV to EnvironmentCreatorPip(model),
+    POETRY to EnvironmentCreatorPoetry(model, moduleOrProject),
+    UV to EnvironmentCreatorUv(model, moduleOrProject),
   )
 
   private val existingInterpreterSelectors = mapOf(
@@ -52,15 +53,6 @@ class PythonAddCustomInterpreter(val model: PythonMutableTargetAddInterpreterMod
       navigator.existingEnvManager = existingInterpreterManager
     }
 
-    // todo delete this. testing busy state
-    //existingInterpreterManager.afterChange {
-    //  model.scope.launch {
-    //    model.interpreterLoading.value = true
-    //    delay(5000)
-    //    model.interpreterLoading.value = false
-    //  }
-    //}
-
     with(outerPanel) {
       buttonsGroup {
         row(message("sdk.create.custom.env.creation.type")) {

diff --git a/python/src/com/jetbrains/python/sdk/add/v2/common.kt b/python/src/com/jetbrains/python/sdk/add/v2/common.kt
@@ -21,6 +21,7 @@ import com.jetbrains.python.newProject.collector.InterpreterStatisticsInfo
 import com.jetbrains.python.sdk.*
 import com.jetbrains.python.sdk.pipenv.PIPENV_ICON
 import com.jetbrains.python.sdk.poetry.POETRY_ICON
+import com.jetbrains.python.sdk.uv.UV_ICON
 import com.jetbrains.python.statistics.InterpreterTarget
 import kotlinx.coroutines.CoroutineScope
 import javax.swing.Icon
@@ -58,6 +59,7 @@ enum class PythonSupportedEnvironmentManagers(val nameKey: String, val icon: Ico
   CONDA("sdk.create.custom.conda", PythonIcons.Python.Anaconda),
   POETRY("sdk.create.custom.poetry", POETRY_ICON),
   PIPENV("sdk.create.custom.pipenv", PIPENV_ICON),
+  UV("sdk.create.custom.uv", UV_ICON),
   PYTHON("sdk.create.custom.python", com.jetbrains.python.psi.icons.PythonPsiApiIcons.Python)
 }
 

diff --git a/python/src/com/jetbrains/python/sdk/add/v2/models.kt b/python/src/com/jetbrains/python/sdk/add/v2/models.kt
@@ -2,7 +2,6 @@
 package com.jetbrains.python.sdk.add.v2
 
 import com.intellij.execution.target.TargetEnvironmentConfiguration
-import com.intellij.ide.util.PropertiesComponent
 import com.intellij.openapi.application.EDT
 import com.intellij.openapi.diagnostic.getOrLogException
 import com.intellij.openapi.fileChooser.FileChooser
@@ -22,8 +21,9 @@ import com.jetbrains.python.sdk.conda.suggestCondaPath
 import com.jetbrains.python.sdk.flavors.PythonSdkFlavor
 import com.jetbrains.python.sdk.flavors.conda.PyCondaEnv
 import com.jetbrains.python.sdk.flavors.conda.PyCondaEnvIdentity
-import com.jetbrains.python.sdk.pipenv.pipEnvPath
-import com.jetbrains.python.sdk.poetry.poetryPath
+import com.jetbrains.python.sdk.pipenv.getPipEnvExecutable
+import com.jetbrains.python.sdk.poetry.getPoetryExecutable
+import com.jetbrains.python.sdk.uv.getUvExecutable
 import com.jetbrains.python.util.ErrorSink
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExperimentalCoroutinesApi
@@ -94,11 +94,6 @@ abstract class PythonAddInterpreterModel(params: PyInterpreterModelParams) {
       withContext(uiContext) {
         state.condaExecutable.set(suggestedCondaLocalPath?.toString().orEmpty())
       }
-
-      //val environments = suggestedCondaPath?.let { PyCondaEnv.getEnvs(executor, suggestedCondaPath).getOrLogException(
-      //  PythonAddInterpreterPresenter.LOG) }
-      //baseConda = environments?.find { env -> env.envIdentity.let { it is PyCondaEnvIdentity.UnnamedEnv && it.isBase } }
-
     }
   }
 
@@ -172,34 +167,32 @@ abstract class PythonMutableTargetAddInterpreterModel(params: PyInterpreterModel
     super.initialize()
     detectPoetryExecutable()
     detectPipEnvExecutable()
+    detectUvExecutable()
   }
 
   suspend fun detectPoetryExecutable() {
-    // todo this is local case, fix for targets
-    val savedPath = PropertiesComponent.getInstance().poetryPath
-    if (savedPath != null) {
-      state.poetryExecutable.set(savedPath)
-    }
-    else {
-      com.jetbrains.python.sdk.poetry.detectPoetryExecutable().getOrNull()?.let {
-        withContext(Dispatchers.EDT) {
-          state.poetryExecutable.set(it.pathString)
-        }
+    // FIXME: support targets
+    getPoetryExecutable().getOrNull()?.let {
+      withContext(Dispatchers.EDT) {
+        state.poetryExecutable.set(it.pathString)
       }
     }
   }
 
   suspend fun detectPipEnvExecutable() {
-    // todo this is local case, fix for targets
-    val savedPath = PropertiesComponent.getInstance().pipEnvPath
-    if (savedPath != null) {
-      state.pipenvExecutable.set(savedPath)
+    // FIXME: support targets
+    getPipEnvExecutable().getOrNull()?.let {
+      withContext(Dispatchers.EDT) {
+        state.pipenvExecutable.set(it.pathString)
+      }
     }
-    else {
-      com.jetbrains.python.sdk.pipenv.detectPipEnvExecutable().getOrNull()?.let {
-        withContext(Dispatchers.EDT) {
-          state.pipenvExecutable.set(it.pathString)
-        }
+  }
+
+  suspend fun detectUvExecutable() {
+    // FIXME: support targets
+    getUvExecutable()?.pathString?.let {
+      withContext(Dispatchers.EDT) {
+        state.uvExecutable.set(it)
       }
     }
   }
@@ -289,6 +282,7 @@ class MutableTargetState(propertyGraph: PropertyGraph) : AddInterpreterState(pro
   val baseInterpreter: ObservableMutableProperty<PythonSelectableInterpreter?> = propertyGraph.property(null)
   val newCondaEnvName: ObservableMutableProperty<String> = propertyGraph.property("")
   val poetryExecutable: ObservableMutableProperty<String> = propertyGraph.property("")
+  val uvExecutable: ObservableMutableProperty<String> = propertyGraph.property("")
   val pipenvExecutable: ObservableMutableProperty<String> = propertyGraph.property("")
   val venvPath: ObservableMutableProperty<String> = propertyGraph.property("")
   val inheritSitePackages = propertyGraph.property(false)

diff --git a/python/src/com/jetbrains/python/sdk/uv/Uv.kt b/python/src/com/jetbrains/python/sdk/uv/Uv.kt
@@ -0,0 +1,21 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+package com.jetbrains.python.sdk.uv
+
+import com.jetbrains.python.packaging.common.PythonPackage
+import com.jetbrains.python.packaging.common.PythonOutdatedPackage
+import com.jetbrains.python.packaging.common.PythonPackageSpecification
+import java.nio.file.Path
+
+interface UvCli {
+  suspend fun runUv(workingDir: Path, vararg args: String): Result<String>
+}
+
+interface UvLowLevel {
+  suspend fun initializeEnvironment(init: Boolean, python: Path?): Result<Path>
+
+  suspend fun listPackages(): Result<List<PythonPackage>>
+  suspend fun listOutdatedPackages(): Result<List<PythonOutdatedPackage>>
+
+  suspend fun installPackage(name: PythonPackageSpecification, options: List<String>): Result<Unit>
+  suspend fun uninstallPackage(name: PythonPackage): Result<Unit>
+}