diff options
Diffstat (limited to 'python/openapi')
4 files changed, 53 insertions, 40 deletions
diff --git a/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java b/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java new file mode 100644 index 000000000000..52dc4732133c --- /dev/null +++ b/python/openapi/src/com/jetbrains/python/documentation/PythonDocumentationQuickInfoProvider.java @@ -0,0 +1,25 @@ +package com.jetbrains.python.documentation; + +import com.intellij.openapi.extensions.ExtensionPointName; +import com.intellij.psi.PsiElement; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * Allows you to inject quick info into python documentation provider + * + * @author Ilya.Kazakevich + */ +public interface PythonDocumentationQuickInfoProvider { + ExtensionPointName<PythonDocumentationQuickInfoProvider> EP_NAME = + ExtensionPointName.create("Pythonid.pythonDocumentationQuickInfoProvider"); + + /** + * Return quick info for <strong>original</strong> element. + * + * @param originalElement original element + * @return info (if exists) or null (if another provider should be checked) + */ + @Nullable + String getQuickInfo(@NotNull PsiElement originalElement); +} diff --git a/python/openapi/src/com/jetbrains/python/packaging/PyPackageManager.java b/python/openapi/src/com/jetbrains/python/packaging/PyPackageManager.java index 3b2080b00ba1..2a8003c46eaf 100644 --- a/python/openapi/src/com/jetbrains/python/packaging/PyPackageManager.java +++ b/python/openapi/src/com/jetbrains/python/packaging/PyPackageManager.java @@ -15,35 +15,45 @@ */ package com.jetbrains.python.packaging; -import com.intellij.openapi.project.Project; +import com.intellij.openapi.module.Module; import com.intellij.openapi.projectRoots.Sdk; +import com.intellij.openapi.util.Key; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; -import java.awt.*; +import java.util.List; +import java.util.Set; /** * @author yole */ public abstract class PyPackageManager { + public static final Key<Boolean> RUNNING_PACKAGING_TASKS = Key.create("PyPackageRequirementsInspection.RunningPackagingTasks"); + + public static final String PACKAGE_SETUPTOOLS = "setuptools"; + public static final String PACKAGE_PIP = "pip"; + public static final String PACKAGE_DISTRIBUTE = "distribute"; + + public static final String USE_USER_SITE = "--user"; + public static PyPackageManager getInstance(Sdk sdk) { return PyPackageManagers.getInstance().forSdk(sdk); } - /** - * Returns true if pip is installed for the specific interpreter; returns false if pip is not - * installed or if it is not currently known whether it's installed (e.g. for a remote interpreter). - * - * @return true if pip is known to be installed, false otherwise. - */ - public abstract boolean hasPip(); - public abstract void install(String requirementString) throws PyExternalProcessException; - public abstract void showInstallationError(Project project, String title, String description); - public abstract void showInstallationError(Component owner, String title, String description); + public abstract void installManagement() throws PyExternalProcessException; + public abstract boolean hasManagement(boolean cachedOnly); + public abstract void install(@NotNull String requirementString) throws PyExternalProcessException; + public abstract void install(@NotNull List<PyRequirement> requirements, @NotNull List<String> extraArgs) throws PyExternalProcessException; + public abstract void uninstall(@NotNull List<PyPackage> packages) throws PyExternalProcessException; public abstract void refresh(); + @NotNull + public abstract String createVirtualEnv(@NotNull String destinationDir, boolean useGlobalSite) throws PyExternalProcessException; @Nullable - public abstract PyPackage findInstalledPackage(String name) throws PyExternalProcessException; - - public abstract boolean findPackage(@NotNull final String name); - + public abstract List<PyPackage> getPackages(boolean cachedOnly) throws PyExternalProcessException; + @Nullable + public abstract PyPackage findPackage(@NotNull String name, boolean cachedOnly) throws PyExternalProcessException; + @Nullable + public abstract List<PyRequirement> getRequirements(@NotNull Module module); + @Nullable + public abstract Set<PyPackage> getDependents(@NotNull PyPackage pkg) throws PyExternalProcessException; } diff --git a/python/openapi/src/com/jetbrains/python/packaging/PyPackageManagers.java b/python/openapi/src/com/jetbrains/python/packaging/PyPackageManagers.java index 9f598748aa7b..2b6554040fe7 100644 --- a/python/openapi/src/com/jetbrains/python/packaging/PyPackageManagers.java +++ b/python/openapi/src/com/jetbrains/python/packaging/PyPackageManagers.java @@ -16,12 +16,8 @@ package com.jetbrains.python.packaging; import com.intellij.openapi.components.ServiceManager; -import com.intellij.openapi.module.Module; import com.intellij.openapi.projectRoots.Sdk; import org.jetbrains.annotations.NotNull; -import org.jetbrains.annotations.Nullable; - -import java.util.List; /** * @author yole @@ -35,22 +31,4 @@ public abstract class PyPackageManagers { @NotNull public abstract PyPackageManager forSdk(Sdk sdk); - - /** - * Returns the list of requirements from 'requirements.txt' or 'setup.py' files in the specified module. - * - * @param module the module to check for requirements - * @return the list of requirements, or null if the module contains neither requirements.txt nor setup.py. - */ - @Nullable - public abstract List<PyRequirement> getRequirements(Module module); - - /** - * Returns the list of requirements from 'requirements.txt' file in the specified module. - * - * @param module the module to check for requirements - * @return the list of requirements, or null if the module does not contain a requirements.txt - */ - @Nullable - public abstract List<PyRequirement> getRequirementsFromTxt(Module module); } diff --git a/python/openapi/src/com/jetbrains/python/templateLanguages/PyTemplatesUtil.java b/python/openapi/src/com/jetbrains/python/templateLanguages/PyTemplatesUtil.java index e660029fe384..c37c65ed4144 100644 --- a/python/openapi/src/com/jetbrains/python/templateLanguages/PyTemplatesUtil.java +++ b/python/openapi/src/com/jetbrains/python/templateLanguages/PyTemplatesUtil.java @@ -40,7 +40,7 @@ public class PyTemplatesUtil { if (templateBinding != null) { if (TemplatesService.ALL_TEMPLATE_BINDINGS.contains(templateBinding)) { try { - final PyPackage installedPackage = packageManager.findInstalledPackage(templateBinding); + final PyPackage installedPackage = packageManager.findPackage(templateBinding, false); if (installedPackage == null) return new ValidationResult(templateBinding + " will be installed on selected interpreter"); } @@ -50,7 +50,7 @@ public class PyTemplatesUtil { } if (language != null) { try { - final PyPackage installedPackage = packageManager.findInstalledPackage(language); + final PyPackage installedPackage = packageManager.findPackage(language, false); if (installedPackage == null) { return new ValidationResult(language + " will be installed on selected interpreter"); } |