Rename files by style guide and change query metadata

alexey · alexey · commit 86ec047be27e · 2019-05-29T15:35:58.000+01:00
diff --git a/change-notes/1.21/analysis-python.md b/change-notes/1.21/analysis-python.md
@@ -10,7 +10,7 @@
   | **Query** | **Tags** | **Purpose** |
   |-----------|----------|-------------|
   | Accepting unknown SSH host keys when using Paramiko (`py/paramiko-missing-host-key-validation`) | security, external/cwe/cwe-295 | Finds instances where Paramiko is configured to accept unknown host keys. Results are shown on LGTM by default. |
-  | Using `return`, `yield`, or `yield from` outside a function or a class method | reliability, correctness | Finds instances where `return`, `yield`, and `yield from` are used outside a function. Results are not shown on LGTM by default. |
+  | Use of 'return' or 'yield' outside a function (`py/return-or-yield-outside-function`) | reliability, correctness | Finds instances where `return`, `yield`, and `yield from` are used outside a function. Results are not shown on LGTM by default. |
 
 ## Changes to existing queries
 
diff --git a/python/ql/src/Statements/ReturnOrYieldOutsideFunction.py b/python/ql/src/Statements/ReturnOrYieldOutsideFunction.py
@@ -1,8 +1,8 @@
-# invalid class with return outside of a function
+# invalid class with return outside a function
 class InvalidClass1(object):
     if [1, 2, 3]:
         return "Exists"
 
-# invalid statement with yield outside of a function
+# invalid statement with yield outside a function
 for i in [1, 2, 3]:
     yield i
diff --git a/python/ql/src/Statements/ReturnOrYieldOutsideFunction.qhelp b/python/ql/src/Statements/ReturnOrYieldOutsideFunction.qhelp
@@ -18,7 +18,7 @@ Consequently, it is not possible to suggest a general fix.</p>
 <p>In this example, a <code>return</code> statement is used outside a class method in a class and
 a <code>yield</code> statement is used outside a function in a scope of a module which would result
 in a <code>SyntaxError</code> when running this code.</p>
-<sample src="ReturnOrYieldOutsideOfFunction.py" />
+<sample src="ReturnOrYieldOutsideFunction.py" />
 </example>
 
 <references>
diff --git a/python/ql/src/Statements/ReturnOrYieldOutsideFunction.ql b/python/ql/src/Statements/ReturnOrYieldOutsideFunction.ql
@@ -1,13 +1,13 @@
 /**
- * @name Using 'return' or 'yield' outside a function causes a 'SyntaxError' at runtime
- * @description Statements 'return' and 'yield' should be used only within a function.
+ * @name Use of 'return' or 'yield' outside a function
+ * @description Using 'return' or 'yield' outside a function causes a 'SyntaxError' at runtime.
  * @kind problem
  * @tags reliability
  *       correctness
  * @problem.severity error
  * @sub-severity low
- * @precision very-high
- * @id py/return-or-yield-outside-of-function
+ * @precision medium
+ * @id py/return-or-yield-outside-function
  */
 
 import python
@@ -22,4 +22,4 @@ where
     or
     node instanceof YieldFrom and kind = "yield from"
   )
-select node, "'" + kind + "' is used outside of a function."
+select node, "'" + kind + "' is used outside a function."
diff --git a/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction.expected b/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction.expected
@@ -0,0 +1,9 @@
+| ReturnOrYieldOutsideFunction_test.py:31:9:31:23 | Return | 'return' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:36:9:36:15 | Yield | 'yield' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:41:9:41:25 | YieldFrom | 'yield from' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:45:5:45:12 | Return | 'return' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:49:5:49:11 | Yield | 'yield' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:53:5:53:16 | YieldFrom | 'yield from' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:57:1:57:14 | YieldFrom | 'yield from' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:60:1:60:12 | Return | 'return' is used outside a function. |
+| ReturnOrYieldOutsideFunction_test.py:63:1:63:11 | Yield | 'yield' is used outside a function. |
diff --git a/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction.qlref b/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction.qlref
@@ -0,0 +1 @@
+Statements/ReturnOrYieldOutsideFunction.ql
diff --git a/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction_test.py b/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideFunction/ReturnOrYieldOutsideFunction_test.py
@@ -25,39 +25,39 @@ def valid_func2():
 def valid_func3():
     yield from [1, 2]
 
-# invalid class with return outside of a function
+# invalid class with return outside a function
 class InvalidClass1(object):
     if [1, 2, 3]:
         return "Exists"
 
-# invalid class with yield outside of a function
+# invalid class with yield outside a function
 class InvalidClass2(object):
     while True:
         yield 1
 
-# invalid class with yield from outside of a function
+# invalid class with yield from outside a function
 class InvalidClass3(object):
     while True:
         yield from [1, 2]
 
-# invalid statement with return outside of a function
+# invalid statement with return outside a function
 for i in [1, 2, 3]:
     return i
 
-# invalid statement with yield outside of a function
+# invalid statement with yield outside a function
 for i in [1, 2, 3]:
     yield i
 
-# invalid statement with yield from outside of a function
+# invalid statement with yield from outside a function
 for i in [1, 2, 3]:
     yield from i
 
-# invalid statement with yield from outside of a function
+# invalid statement with yield from outside a function
 var = [1,2,3]
 yield from var
 
-# invalid statement with return outside of a function
+# invalid statement with return outside a function
 return False
 
-# invalid statement with yield outside of a function
+# invalid statement with yield outside a function
 yield False
diff --git a/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideOfFunction/ReturnOrYieldOutsideOfFunction.qlref b/python/ql/test/query-tests/Statements/ReturnOrYieldOutsideOfFunction/ReturnOrYieldOutsideOfFunction.qlref

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Statements/ReturnOrYieldOutsideFunction.ql`