blob: 1786b934159b2715916213d302c6f4856c105eae (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*
* Copyright 2000-2013 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.psi;
import com.intellij.psi.PsiFile;
import com.jetbrains.python.codeInsight.controlflow.ScopeOwner;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
public interface PyFile extends PyElement, PsiFile, PyDocStringOwner, ScopeOwner, NameDefiner {
List<PyStatement> getStatements();
List<PyClass> getTopLevelClasses();
List<PyFunction> getTopLevelFunctions();
List<PyTargetExpression> getTopLevelAttributes();
@Nullable
PyFunction findTopLevelFunction(String name);
@Nullable
PyClass findTopLevelClass(String name);
@Nullable
PyTargetExpression findTopLevelAttribute(String name);
LanguageLevel getLanguageLevel();
/**
* Return the list of all 'from ... import' statements in the top-level scope of the file.
*
* @return the list of 'from ... import' statements.
*/
@NotNull
List<PyFromImportStatement> getFromImports();
/**
* Returns the list of import elements in all 'import xxx' statements in the top-level scope of the file.
*
* @return the list of import targets.
*/
@NotNull
List<PyImportElement> getImportTargets();
/**
* Returns the list of names in the __all__ declaration, or null if there is no such declaration in the module.
*
* @return the list of names or null.
*/
@Nullable
List<String> getDunderAll();
/**
* Return true if the file contains a 'from __future__ import ...' statement with given feature.
*/
boolean hasImportFromFuture(FutureFeature feature);
/**
* If the function raises a DeprecationWarning or a PendingDeprecationWarning, returns the explanation text provided for the warning.
*
* @return the deprecation message or null if the function is not deprecated.
*/
String getDeprecationMessage();
/**
* Returns the sequential list of import statements in the beginning of the file.
*/
List<PyImportStatementBase> getImportBlock();
}
|
