Add isPositionalOnly API to Function Symbol parameters

andreaguarino · gyula-sallai-sonarsource · commit 5d32f0ca3499 · 2020-03-19T07:59:38.000+01:00
diff --git a/python-frontend/src/main/java/org/sonar/plugins/python/api/symbols/FunctionSymbol.java b/python-frontend/src/main/java/org/sonar/plugins/python/api/symbols/FunctionSymbol.java
@@ -48,6 +48,7 @@ interface Parameter {
     String name();
     boolean hasDefaultValue();
     boolean isKeywordOnly();
+    boolean isPositionalOnly();
     @CheckForNull
     LocationInFile location();
   }
diff --git a/python-frontend/src/main/java/org/sonar/python/semantic/FunctionSymbolImpl.java b/python-frontend/src/main/java/org/sonar/python/semantic/FunctionSymbolImpl.java
@@ -118,26 +118,40 @@ private static boolean isInstanceMethod(FunctionDef functionDef) {
   }
 
   private void createParameterNames(List<AnyParameter> parameterTrees, @Nullable String fileId) {
-    boolean keywordOnly = false;
+    ParameterState parameterState = new ParameterState();
     for (AnyParameter anyParameter : parameterTrees) {
       if (anyParameter.is(Tree.Kind.PARAMETER)) {
-        org.sonar.plugins.python.api.tree.Parameter parameter = (org.sonar.plugins.python.api.tree.Parameter) anyParameter;
-        Name parameterName = parameter.name();
-        Token starToken = parameter.starToken();
-        if (parameterName != null) {
-          this.parameters.add(new ParameterImpl(parameterName.name(), parameter.defaultValue() != null, keywordOnly, locationInFile(anyParameter, fileId)));
-          if (starToken != null) {
-            hasVariadicParameter = true;
-          }
-        } else if (starToken != null && "*".equals(starToken.value())) {
-          keywordOnly = true;
-        }
+        addParameter((org.sonar.plugins.python.api.tree.Parameter) anyParameter, fileId, parameterState);
       } else {
-        parameters.add(new ParameterImpl(null, false, false, locationInFile(anyParameter, fileId)));
+        parameters.add(new ParameterImpl(null, false, parameterState, locationInFile(anyParameter, fileId)));
+      }
+    }
+  }
+
+  private void addParameter(org.sonar.plugins.python.api.tree.Parameter parameter, @Nullable String fileId, ParameterState parameterState) {
+    Name parameterName = parameter.name();
+    Token starToken = parameter.starToken();
+    if (parameterName != null) {
+      this.parameters.add(new ParameterImpl(parameterName.name(), parameter.defaultValue() != null, parameterState, locationInFile(parameter, fileId)));
+      if (starToken != null) {
+        hasVariadicParameter = true;
+      }
+    } else if (starToken != null) {
+      if ("*".equals(starToken.value())) {
+        parameterState.keywordOnly = true;
+        parameterState.positionalOnly = false;
+      }
+      if ("/".equals(starToken.value())) {
+        parameterState.positionalOnly = true;
       }
     }
   }
 
+  private static class ParameterState {
+    boolean keywordOnly = false;
+    boolean positionalOnly = false;
+  }
+
   @Override
   public List<Parameter> parameters() {
     return parameters;
@@ -189,12 +203,14 @@ private static class ParameterImpl implements Parameter {
     private final String name;
     private final boolean hasDefaultValue;
     private final boolean isKeywordOnly;
+    private final boolean isPositionalOnly;
     private final LocationInFile location;
 
-    ParameterImpl(@Nullable String name, boolean hasDefaultValue, boolean isKeywordOnly, @Nullable LocationInFile location) {
+    ParameterImpl(@Nullable String name, boolean hasDefaultValue, ParameterState parameterState, @Nullable LocationInFile location) {
       this.name = name;
       this.hasDefaultValue = hasDefaultValue;
-      this.isKeywordOnly = isKeywordOnly;
+      this.isKeywordOnly = parameterState.keywordOnly;
+      this.isPositionalOnly = parameterState.positionalOnly;
       this.location = location;
     }
 
@@ -214,6 +230,11 @@ public boolean isKeywordOnly() {
       return isKeywordOnly;
     }
 
+    @Override
+    public boolean isPositionalOnly() {
+      return isPositionalOnly;
+    }
+
     @CheckForNull
     @Override
     public LocationInFile location() {
diff --git a/python-frontend/src/test/java/org/sonar/python/semantic/FunctionSymbolTest.java b/python-frontend/src/test/java/org/sonar/python/semantic/FunctionSymbolTest.java
@@ -60,6 +60,12 @@ public void arity() {
     functionSymbol = functionSymbol("def fn(p1, /, p2): pass");
     assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::name).containsExactly("p1", "p2");
     assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::isKeywordOnly).containsExactly(false, false);
+    assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::isPositionalOnly).containsExactly(false, true);
+
+    functionSymbol = functionSymbol("def fn(p1, /, p2, *, p3): pass");
+    assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::name).containsExactly("p1", "p2", "p3");
+    assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::isKeywordOnly).containsExactly(false, false, true);
+    assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::isPositionalOnly).containsExactly(false, true, false);
 
     functionSymbol = functionSymbol("def fn(p1, p2=42): pass");
     assertThat(functionSymbol.parameters()).extracting(FunctionSymbol.Parameter::name).containsExactly("p1", "p2");

Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ interface Parameter {`
`48`	`48`	`String name();`
`49`	`49`	`boolean hasDefaultValue();`
`50`	`50`	`boolean isKeywordOnly();`
	`51`	`+ boolean isPositionalOnly();`
`51`	`52`	`@CheckForNull`
`52`	`53`	`LocationInFile location();`
`53`	`54`	`}`