[python] packages moved to com.jetbrains.python package, as whole community.python.impl must be there

GitOrigin-RevId: 339a5be4b4c260ce0c31ee2245870ef953065b2d

python/python-core-impl/src/com/jetbrains/extensions/ModuleExt.kt

@@ -18,6 +18,8 @@ package com.jetbrains.extensions
 import com.intellij.openapi.module.Module
 import com.intellij.openapi.projectRoots.Sdk
 import com.intellij.openapi.roots.ModuleRootManager
+import org.jetbrains.annotations.ApiStatus.ScheduledForRemoval
 
-
+@Deprecated(message = "Moved to com.jetbrains.python")
+@ScheduledForRemoval
 fun Module.getSdk(): Sdk? = ModuleRootManager.getInstance(this).sdk

python/python-core-impl/src/com/jetbrains/extensions/QualifiedNameExt.kt

@@ -1,18 +1,4 @@
-/*
- * Copyright 2000-2017 JetBrains s.r.o.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+// 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.extensions
 
 import com.intellij.openapi.module.Module
@@ -34,9 +20,14 @@ import com.jetbrains.python.psi.resolve.*
 import com.jetbrains.python.psi.stubs.PyModuleNameIndex
 import com.jetbrains.python.psi.types.TypeEvalContext
 import com.jetbrains.python.sdk.PySdkUtil
+import org.jetbrains.annotations.ApiStatus
 import java.util.*
 
-
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 interface ContextAnchor {
   val sdk: Sdk?
   val project: Project
@@ -47,6 +38,11 @@ interface ContextAnchor {
   }
 }
 
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 class ModuleBasedContextAnchor(val module: Module) : ContextAnchor {
   override val sdk: Sdk? = module.getSdk()
   override val project: Project = module.project
@@ -58,16 +54,11 @@ class ModuleBasedContextAnchor(val module: Module) : ContextAnchor {
   }
 }
 
-class ProjectSdkContextAnchor(override val project: Project, override val sdk: Sdk?) : ContextAnchor {
-  override val qualifiedNameResolveContext: PyQualifiedNameResolveContext? = sdk?.let { fromSdk(project, it) }
-  override val scope: GlobalSearchScope = GlobalSearchScope.projectScope(project) //TODO: Check if project scope includes SDK
-  override fun getRoots(): Array<VirtualFile> {
-    val manager = ProjectRootManager.getInstance(project)
-    return super.getRoots() + manager.contentRoots + manager.contentSourceRoots
-  }
-}
-
-
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 data class QNameResolveContext(
   val contextAnchor: ContextAnchor,
   /**
@@ -86,9 +77,21 @@ data class QNameResolveContext(
   val allowInaccurateResult: Boolean = false
 )
 
+
 /**
- * @return qname part relative to root
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
  */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
+fun QualifiedName.resolveToElement(context: QNameResolveContext, stopOnFirstFail: Boolean = false): PsiElement? {
+  return getElementAndResolvableName(context, stopOnFirstFail)?.element
+}
+
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 fun QualifiedName.getRelativeNameTo(root: QualifiedName): QualifiedName? {
   if (Collections.indexOfSubList(components, root.components) == -1) {
     return null
@@ -97,22 +100,31 @@ fun QualifiedName.getRelativeNameTo(root: QualifiedName): QualifiedName? {
 }
 
 /**
- * Resolves qname of any symbol to appropriate PSI element.
- * Shortcut for [getElementAndResolvableName]
- * @see [getElementAndResolvableName]
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
  */
-fun QualifiedName.resolveToElement(context: QNameResolveContext, stopOnFirstFail: Boolean = false): PsiElement? {
-  return getElementAndResolvableName(context, stopOnFirstFail)?.element
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
+class ProjectSdkContextAnchor(override val project: Project, override val sdk: Sdk?) : com.jetbrains.python.extensions.ContextAnchor {
+  override val qualifiedNameResolveContext: PyQualifiedNameResolveContext? = sdk?.let { fromSdk(project, it) }
+  override val scope: GlobalSearchScope = GlobalSearchScope.projectScope(project) //TODO: Check if project scope includes SDK
+  override fun getRoots(): Array<VirtualFile> {
+    val manager = ProjectRootManager.getInstance(project)
+    return super.getRoots() + manager.contentRoots + manager.contentSourceRoots
+  }
 }
 
-
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 data class NameAndElement(val name: QualifiedName, val element: PsiElement)
 
 /**
- * Resolves qname of any symbol to PSI element popping tail until element becomes resolved or only one time if stopOnFirstFail
- * @return element and longest name that was resolved successfully.
- * @see [resolveToElement]
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
  */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 fun QualifiedName.getElementAndResolvableName(context: QNameResolveContext, stopOnFirstFail: Boolean = false): NameAndElement? {
   var currentName = QualifiedName.fromComponents(this.components)
 

python/python-core-impl/src/com/jetbrains/extensions/package-info.java

@@ -0,0 +1,9 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated
+package com.jetbrains.extensions;
+
+import org.jetbrains.annotations.ApiStatus;

python/python-core-impl/src/com/jetbrains/extensions/python/PyCallExpressionExt.kt

@@ -1,21 +1,16 @@
 // Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
-package com.jetbrains.extensions.python
+
+package com.jetbrains.extensions.python;
 
 import com.jetbrains.python.nameResolver.FQNamesProvider
 import com.jetbrains.python.nameResolver.NameResolverTools
-import com.jetbrains.python.psi.PyAssignmentStatement
 import com.jetbrains.python.psi.PyCallExpression
-import com.jetbrains.python.psi.PyPossibleClassMember
+import org.jetbrains.annotations.ApiStatus
 
 /**
- * Checks if ``foo = SomeExpr()`` where foo is class attribute
- */
-val PyCallExpression.isClassAttribute: Boolean
-  get() =
-    (parent as? PyAssignmentStatement)?.targets?.filterIsInstance<PyPossibleClassMember>()?.any { it.containingClass != null } == true
-
-/**
- * Checks if callee has certain name. Only name is checked, so import aliases aren't supported, but it works pretty fast
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
  */
+@ApiStatus.ScheduledForRemoval
+@Deprecated(message = "Moved to com.jetbrains.python")
 fun PyCallExpression.isCalleeName(vararg names: FQNamesProvider): Boolean = NameResolverTools.isCalleeShortCut(this, *names)
 

python/python-core-impl/src/com/jetbrains/extensions/python/package-info.java

@@ -0,0 +1,9 @@
+// Copyright 2000-2024 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license.
+/**
+ * @deprecated moved to {@link com.jetbrains.python.extensions}
+ */
+@ApiStatus.ScheduledForRemoval
+@Deprecated
+package com.jetbrains.extensions.python;
+
+import org.jetbrains.annotations.ApiStatus;

python/python-core-impl/src/com/jetbrains/python/extensions/ModuleExt.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2000-2016 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.jetbrains.python.extensions
+
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.projectRoots.Sdk
+import com.intellij.openapi.roots.ModuleRootManager
+
+
+fun Module.getSdk(): Sdk? = ModuleRootManager.getInstance(this).sdk

python/python-core-impl/src/com/jetbrains/python/extensions/QualifiedNameExt.kt

@@ -0,0 +1,168 @@
+// 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.extensions
+
+import com.intellij.openapi.module.Module
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.projectRoots.Sdk
+import com.intellij.openapi.roots.ModuleRootManager
+import com.intellij.openapi.roots.OrderRootType
+import com.intellij.openapi.roots.ProjectRootManager
+import com.intellij.openapi.vfs.VirtualFile
+import com.intellij.psi.PsiDirectory
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiManager
+import com.intellij.psi.search.GlobalSearchScope
+import com.intellij.psi.util.QualifiedName
+import com.jetbrains.python.PyNames
+import com.jetbrains.python.psi.PyClass
+import com.jetbrains.python.psi.PyFile
+import com.jetbrains.python.psi.resolve.*
+import com.jetbrains.python.psi.stubs.PyModuleNameIndex
+import com.jetbrains.python.psi.types.TypeEvalContext
+import com.jetbrains.python.sdk.PySdkUtil
+import java.util.*
+
+
+interface ContextAnchor {
+  val sdk: Sdk?
+  val project: Project
+  val qualifiedNameResolveContext: PyQualifiedNameResolveContext?
+  val scope: GlobalSearchScope
+  fun getRoots(): Array<VirtualFile> {
+    return sdk?.rootProvider?.getFiles(OrderRootType.CLASSES) ?: emptyArray()
+  }
+}
+
+class ModuleBasedContextAnchor(val module: Module) : ContextAnchor {
+  override val sdk: Sdk? = module.getSdk()
+  override val project: Project = module.project
+  override val qualifiedNameResolveContext: PyQualifiedNameResolveContext = fromModule(module)
+  override val scope: GlobalSearchScope = module.moduleContentScope
+  override fun getRoots(): Array<VirtualFile> {
+    val manager = ModuleRootManager.getInstance(module)
+    return super.getRoots() + manager.contentRoots + manager.sourceRoots
+  }
+}
+
+class ProjectSdkContextAnchor(override val project: Project, override val sdk: Sdk?) : ContextAnchor {
+  override val qualifiedNameResolveContext: PyQualifiedNameResolveContext? = sdk?.let { fromSdk(project, it) }
+  override val scope: GlobalSearchScope = GlobalSearchScope.projectScope(project) //TODO: Check if project scope includes SDK
+  override fun getRoots(): Array<VirtualFile> {
+    val manager = ProjectRootManager.getInstance(project)
+    return super.getRoots() + manager.contentRoots + manager.contentSourceRoots
+  }
+}
+
+
+data class QNameResolveContext(
+  val contextAnchor: ContextAnchor,
+  /**
+   * Used for language level etc
+   */
+  val sdk: Sdk? = contextAnchor.sdk,
+
+  val evalContext: TypeEvalContext,
+  /**
+   * If not provided resolves against roots only. Resolved also against this folder otherwise
+   */
+  val folderToStart: VirtualFile? = null,
+  /**
+   * Use index, plain dirs with Py2 and so on. May resolve names unresolvable in other cases, but may return false results.
+   */
+  val allowInaccurateResult: Boolean = false
+)
+
+/**
+ * @return qname part relative to root
+ */
+fun QualifiedName.getRelativeNameTo(root: QualifiedName): QualifiedName? {
+  if (Collections.indexOfSubList(components, root.components) == -1) {
+    return null
+  }
+  return subQualifiedName(root.componentCount, componentCount)
+}
+
+/**
+ * Resolves qname of any symbol to appropriate PSI element.
+ * Shortcut for [getElementAndResolvableName]
+ * @see [getElementAndResolvableName]
+ */
+fun QualifiedName.resolveToElement(context: QNameResolveContext, stopOnFirstFail: Boolean = false): PsiElement? {
+  return getElementAndResolvableName(context, stopOnFirstFail)?.element
+}
+
+
+data class NameAndElement(val name: QualifiedName, val element: PsiElement)
+
+/**
+ * Resolves qname of any symbol to PSI element popping tail until element becomes resolved or only one time if stopOnFirstFail
+ * @return element and longest name that was resolved successfully.
+ * @see [resolveToElement]
+ */
+fun QualifiedName.getElementAndResolvableName(context: QNameResolveContext, stopOnFirstFail: Boolean = false): NameAndElement? {
+  var currentName = QualifiedName.fromComponents(this.components)
+
+
+  var element: PsiElement? = null
+
+
+  var lastElement: String? = null
+  var psiDirectory: PsiDirectory? = null
+
+  var resolveContext = context.contextAnchor.qualifiedNameResolveContext?.copyWithMembers() ?: return null
+  if (PySdkUtil.getLanguageLevelForSdk(context.sdk).isPy3K || context.allowInaccurateResult) {
+    resolveContext = resolveContext.copyWithPlainDirectories()
+  }
+
+  if (context.folderToStart != null) {
+    psiDirectory = PsiManager.getInstance(context.contextAnchor.project).findDirectory(context.folderToStart)
+  }
+
+
+  // Drill as deep, as we can
+  while (currentName.componentCount > 0 && element == null) {
+    if (psiDirectory != null) { // Resolve against folder
+      // There could be folder and module on the same level. Empty folder should be ignored in this case.
+      element = resolveModuleAt(currentName, psiDirectory, resolveContext).filterNot {
+        it is PsiDirectory && it.children.filterIsInstance<PyFile>().isEmpty()
+      }.firstOrNull()
+    }
+
+    if (element == null) { // Resolve against roots
+      element = resolveQualifiedName(currentName, resolveContext).firstOrNull()
+    }
+
+    if (element != null || stopOnFirstFail) {
+      break
+    }
+    lastElement = currentName.lastComponent!!
+    currentName = currentName.removeLastComponent()
+  }
+
+  if (lastElement != null && element is PyClass) {
+    // Drill in class
+
+    //TODO: Support nested classes
+    val method = element.findMethodByName(lastElement, true, context.evalContext)
+    if (method != null) {
+      return NameAndElement(currentName.append(lastElement), method)
+    }
+
+  }
+
+  if (element == null && this.firstComponent != null && context.allowInaccurateResult) {
+    // If name starts with file which is not in root nor in folders -- use index.
+    val nameToFind = this.firstComponent!!
+    val pyFile = PyModuleNameIndex.find(nameToFind, context.contextAnchor.project, false).firstOrNull() ?: return element
+
+    val folder =
+      if (pyFile.name == PyNames.INIT_DOT_PY) { // We are in folder
+        pyFile.virtualFile.parent.parent
+      }
+      else {
+        pyFile.virtualFile.parent
+      }
+    return getElementAndResolvableName(context.copy(folderToStart = folder))
+  }
+  return if (element != null) NameAndElement(currentName, element) else null
+}

python/python-core-impl/src/com/jetbrains/python/extensions/RegExpPatternExt.kt

@@ -1,5 +1,5 @@
 // Copyright 2000-2017 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
-package com.jetbrains.extensions
+package com.jetbrains.python.extensions
 
 import org.intellij.lang.regexp.psi.RegExpPattern
 import java.util.regex.Pattern

python/python-core-impl/src/com/jetbrains/python/extensions/python/PyCallExpressionExt.kt

@@ -0,0 +1,21 @@
+// Copyright 2000-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
+package com.jetbrains.python.extensions.python
+
+import com.jetbrains.python.nameResolver.FQNamesProvider
+import com.jetbrains.python.nameResolver.NameResolverTools
+import com.jetbrains.python.psi.PyAssignmentStatement
+import com.jetbrains.python.psi.PyCallExpression
+import com.jetbrains.python.psi.PyPossibleClassMember
+
+/**
+ * Checks if ``foo = SomeExpr()`` where foo is class attribute
+ */
+val PyCallExpression.isClassAttribute: Boolean
+  get() =
+    (parent as? PyAssignmentStatement)?.targets?.filterIsInstance<PyPossibleClassMember>()?.any { it.containingClass != null } == true
+
+/**
+ * Checks if callee has certain name. Only name is checked, so import aliases aren't supported, but it works pretty fast
+ */
+fun PyCallExpression.isCalleeName(vararg names: FQNamesProvider): Boolean = NameResolverTools.isCalleeShortCut(this, *names)
+