PY-20744 Parse PEP-526 variable annotations
[idea/community.git] / python / psi-api / src / com / jetbrains / python / psi / PyNamedParameter.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.jetbrains.python.psi;
17
18 import com.intellij.psi.PsiNameIdentifierOwner;
19 import com.intellij.psi.PsiNamedElement;
20 import com.intellij.psi.StubBasedPsiElement;
21 import com.jetbrains.python.psi.stubs.PyNamedParameterStub;
22 import org.jetbrains.annotations.NotNull;
23
24 /**
25  * Represents a named parameter, as opposed to a tuple parameter.
26  */
27 public interface PyNamedParameter extends PyParameter, PsiNamedElement, PsiNameIdentifierOwner, PyExpression, PyTypeCommentOwner,
28                                           PyAnnotationOwner, StubBasedPsiElement<PyNamedParameterStub> {
29   boolean isPositionalContainer();
30
31   boolean isKeywordContainer();
32
33   /**
34    * Parameter is considered "keyword-only" if it appears after named or unnamed positional vararg parameter.
35    * See PEP-3102 for more details.
36    *
37    * @return whether this parameter is keyword-only
38    */
39   boolean isKeywordOnly();
40
41   /**
42    * @param includeDefaultValue if true, include the default value after an " = ".
43    * @return Canonical representation of parameter. Includes asterisks for *param and **param, and name.
44    */
45   @NotNull
46   String getRepr(boolean includeDefaultValue);
47 }
48