Skip to content

Commit e72e662

Browse files
committed
Python: Autogenerate QLDoc for toString AST methods.
Only adds these for the methods that do not `override` other methods (as these presumably have their own `toString` documentation).
1 parent 24daf2c commit e72e662

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

python/ql/src/semmle/python/AstGenerated.qll

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ library class Bytes_ extends @py_Bytes, Expr {
188188

189189
/** INTERNAL: See the class `BytesOrStr` for further information. */
190190
library class BytesOrStr_ extends @py_Bytes_or_Str {
191+
/** Gets a textual representation of this element. */
191192
string toString() { result = "BytesOrStr" }
192193
}
193194

@@ -233,6 +234,7 @@ library class Class_ extends @py_Class {
233234

234235
ClassExpr getParent() { py_Classes(this, result) }
235236

237+
/** Gets a textual representation of this element. */
236238
string toString() { result = "Class" }
237239
}
238240

@@ -513,6 +515,7 @@ library class Function_ extends @py_Function {
513515

514516
FunctionParent getParent() { py_Functions(this, result) }
515517

518+
/** Gets a textual representation of this element. */
516519
string toString() { result = "Function" }
517520
}
518521

@@ -535,6 +538,7 @@ library class FunctionExpr_ extends @py_FunctionExpr, Expr {
535538

536539
/** INTERNAL: See the class `FunctionParent` for further information. */
537540
library class FunctionParent_ extends @py_Function_parent {
541+
/** Gets a textual representation of this element. */
538542
string toString() { result = "FunctionParent" }
539543
}
540544

@@ -811,6 +815,7 @@ library class Module_ extends @py_Module {
811815
/** Gets the kind of this module. */
812816
string getKind() { py_strs(result, this, 3) }
813817

818+
/** Gets a textual representation of this element. */
814819
string toString() { result = "Module" }
815820
}
816821

@@ -1070,6 +1075,7 @@ library class StringPart_ extends @py_StringPart {
10701075

10711076
StringPartList getParent() { py_StringParts(this, result, _) }
10721077

1078+
/** Gets a textual representation of this element. */
10731079
string toString() { result = "StringPart" }
10741080
}
10751081

@@ -1083,6 +1089,7 @@ library class StringPartList_ extends @py_StringPart_list {
10831089
/** Gets the nth item of this implicitly concatenated part list */
10841090
StringPart getItem(int index) { py_StringParts(result, this, index) }
10851091

1092+
/** Gets a textual representation of this element. */
10861093
string toString() { result = "StringPartList" }
10871094
}
10881095

@@ -1283,6 +1290,7 @@ library class Alias_ extends @py_alias {
12831290

12841291
AliasList getParent() { py_aliases(this, result, _) }
12851292

1293+
/** Gets a textual representation of this element. */
12861294
string toString() { result = "Alias" }
12871295
}
12881296

@@ -1296,6 +1304,7 @@ library class AliasList_ extends @py_alias_list {
12961304
/** Gets the nth item of this alias list */
12971305
Alias getItem(int index) { py_aliases(result, this, index) }
12981306

1307+
/** Gets a textual representation of this element. */
12991308
string toString() { result = "AliasList" }
13001309
}
13011310

@@ -1345,35 +1354,41 @@ library class Arguments_ extends @py_arguments {
13451354

13461355
ArgumentsParent getParent() { py_arguments(this, result) }
13471356

1357+
/** Gets a textual representation of this element. */
13481358
string toString() { result = "Arguments" }
13491359
}
13501360

13511361
/** INTERNAL: See the class `ArgumentsParent` for further information. */
13521362
library class ArgumentsParent_ extends @py_arguments_parent {
1363+
/** Gets a textual representation of this element. */
13531364
string toString() { result = "ArgumentsParent" }
13541365
}
13551366

13561367
/** INTERNAL: See the class `AstNode` for further information. */
13571368
library class AstNode_ extends @py_ast_node {
1369+
/** Gets a textual representation of this element. */
13581370
string toString() { result = "AstNode" }
13591371
}
13601372

13611373
/** INTERNAL: See the class `BoolParent` for further information. */
13621374
library class BoolParent_ extends @py_bool_parent {
1375+
/** Gets a textual representation of this element. */
13631376
string toString() { result = "BoolParent" }
13641377
}
13651378

13661379
/** INTERNAL: See the class `Boolop` for further information. */
13671380
library class Boolop_ extends @py_boolop {
13681381
BoolExpr getParent() { py_boolops(this, _, result) }
13691382

1383+
/** Gets a textual representation of this element. */
13701384
string toString() { result = "Boolop" }
13711385
}
13721386

13731387
/** INTERNAL: See the class `Cmpop` for further information. */
13741388
library class Cmpop_ extends @py_cmpop {
13751389
CmpopList getParent() { py_cmpops(this, _, result, _) }
13761390

1391+
/** Gets a textual representation of this element. */
13771392
string toString() { result = "Cmpop" }
13781393
}
13791394

@@ -1387,6 +1402,7 @@ library class CmpopList_ extends @py_cmpop_list {
13871402
/** Gets the nth item of this comparison operator list */
13881403
Cmpop getItem(int index) { py_cmpops(result, _, this, index) }
13891404

1405+
/** Gets a textual representation of this element. */
13901406
string toString() { result = "CmpopList" }
13911407
}
13921408

@@ -1412,6 +1428,7 @@ library class Comprehension_ extends @py_comprehension {
14121428

14131429
ComprehensionList getParent() { py_comprehensions(this, result, _) }
14141430

1431+
/** Gets a textual representation of this element. */
14151432
string toString() { result = "Comprehension" }
14161433
}
14171434

@@ -1425,13 +1442,15 @@ library class ComprehensionList_ extends @py_comprehension_list {
14251442
/** Gets the nth item of this comprehension list */
14261443
Comprehension getItem(int index) { py_comprehensions(result, this, index) }
14271444

1445+
/** Gets a textual representation of this element. */
14281446
string toString() { result = "ComprehensionList" }
14291447
}
14301448

14311449
/** INTERNAL: See the class `DictItem` for further information. */
14321450
library class DictItem_ extends @py_dict_item {
14331451
DictItemList getParent() { py_dict_items(this, _, result, _) }
14341452

1453+
/** Gets a textual representation of this element. */
14351454
string toString() { result = "DictItem" }
14361455
}
14371456

@@ -1445,11 +1464,13 @@ library class DictItemList_ extends @py_dict_item_list {
14451464
/** Gets the nth item of this dict_item list */
14461465
DictItem getItem(int index) { py_dict_items(result, _, this, index) }
14471466

1467+
/** Gets a textual representation of this element. */
14481468
string toString() { result = "DictItemList" }
14491469
}
14501470

14511471
/** INTERNAL: See the class `DictItemListParent` for further information. */
14521472
library class DictItemListParent_ extends @py_dict_item_list_parent {
1473+
/** Gets a textual representation of this element. */
14531474
string toString() { result = "DictItemListParent" }
14541475
}
14551476

@@ -1463,18 +1484,21 @@ library class Expr_ extends @py_expr {
14631484

14641485
ExprParent getParent() { py_exprs(this, _, result, _) }
14651486

1487+
/** Gets a textual representation of this element. */
14661488
string toString() { result = "Expr" }
14671489
}
14681490

14691491
/** INTERNAL: See the class `ExprContext` for further information. */
14701492
library class ExprContext_ extends @py_expr_context {
14711493
ExprContextParent getParent() { py_expr_contexts(this, _, result) }
14721494

1495+
/** Gets a textual representation of this element. */
14731496
string toString() { result = "ExprContext" }
14741497
}
14751498

14761499
/** INTERNAL: See the class `ExprContextParent` for further information. */
14771500
library class ExprContextParent_ extends @py_expr_context_parent {
1501+
/** Gets a textual representation of this element. */
14781502
string toString() { result = "ExprContextParent" }
14791503
}
14801504

@@ -1488,21 +1512,25 @@ library class ExprList_ extends @py_expr_list {
14881512
/** Gets the nth item of this expression list */
14891513
Expr getItem(int index) { py_exprs(result, _, this, index) }
14901514

1515+
/** Gets a textual representation of this element. */
14911516
string toString() { result = "ExprList" }
14921517
}
14931518

14941519
/** INTERNAL: See the class `ExprListParent` for further information. */
14951520
library class ExprListParent_ extends @py_expr_list_parent {
1521+
/** Gets a textual representation of this element. */
14961522
string toString() { result = "ExprListParent" }
14971523
}
14981524

14991525
/** INTERNAL: See the class `ExprOrStmt` for further information. */
15001526
library class ExprOrStmt_ extends @py_expr_or_stmt {
1527+
/** Gets a textual representation of this element. */
15011528
string toString() { result = "ExprOrStmt" }
15021529
}
15031530

15041531
/** INTERNAL: See the class `ExprParent` for further information. */
15051532
library class ExprParent_ extends @py_expr_parent {
1533+
/** Gets a textual representation of this element. */
15061534
string toString() { result = "ExprParent" }
15071535
}
15081536

@@ -1522,23 +1550,27 @@ library class Keyword_ extends @py_keyword, DictItem {
15221550

15231551
/** INTERNAL: See the class `LocationParent` for further information. */
15241552
library class LocationParent_ extends @py_location_parent {
1553+
/** Gets a textual representation of this element. */
15251554
string toString() { result = "LocationParent" }
15261555
}
15271556

15281557
/** INTERNAL: See the class `Operator` for further information. */
15291558
library class Operator_ extends @py_operator {
15301559
BinaryExpr getParent() { py_operators(this, _, result) }
15311560

1561+
/** Gets a textual representation of this element. */
15321562
string toString() { result = "Operator" }
15331563
}
15341564

15351565
/** INTERNAL: See the class `Parameter` for further information. */
15361566
library class Parameter_ extends @py_parameter {
1567+
/** Gets a textual representation of this element. */
15371568
string toString() { result = "Parameter" }
15381569
}
15391570

15401571
/** INTERNAL: See the class `Scope` for further information. */
15411572
library class Scope_ extends @py_scope {
1573+
/** Gets a textual representation of this element. */
15421574
string toString() { result = "Scope" }
15431575
}
15441576

@@ -1549,6 +1581,7 @@ library class Stmt_ extends @py_stmt {
15491581

15501582
StmtList getParent() { py_stmts(this, _, result, _) }
15511583

1584+
/** Gets a textual representation of this element. */
15521585
string toString() { result = "Stmt" }
15531586
}
15541587

@@ -1562,11 +1595,13 @@ library class StmtList_ extends @py_stmt_list {
15621595
/** Gets the nth item of this statement list */
15631596
Stmt getItem(int index) { py_stmts(result, _, this, index) }
15641597

1598+
/** Gets a textual representation of this element. */
15651599
string toString() { result = "StmtList" }
15661600
}
15671601

15681602
/** INTERNAL: See the class `StmtListParent` for further information. */
15691603
library class StmtListParent_ extends @py_stmt_list_parent {
1604+
/** Gets a textual representation of this element. */
15701605
string toString() { result = "StmtListParent" }
15711606
}
15721607

@@ -1580,27 +1615,32 @@ library class StringList_ extends @py_str_list {
15801615
/** Gets the nth item of this string list */
15811616
string getItem(int index) { py_strs(result, this, index) }
15821617

1618+
/** Gets a textual representation of this element. */
15831619
string toString() { result = "StringList" }
15841620
}
15851621

15861622
/** INTERNAL: See the class `StrListParent` for further information. */
15871623
library class StrListParent_ extends @py_str_list_parent {
1624+
/** Gets a textual representation of this element. */
15881625
string toString() { result = "StrListParent" }
15891626
}
15901627

15911628
/** INTERNAL: See the class `StrParent` for further information. */
15921629
library class StrParent_ extends @py_str_parent {
1630+
/** Gets a textual representation of this element. */
15931631
string toString() { result = "StrParent" }
15941632
}
15951633

15961634
/** INTERNAL: See the class `Unaryop` for further information. */
15971635
library class Unaryop_ extends @py_unaryop {
15981636
UnaryExpr getParent() { py_unaryops(this, _, result) }
15991637

1638+
/** Gets a textual representation of this element. */
16001639
string toString() { result = "Unaryop" }
16011640
}
16021641

16031642
/** INTERNAL: See the class `VariableParent` for further information. */
16041643
library class VariableParent_ extends @py_variable_parent {
1644+
/** Gets a textual representation of this element. */
16051645
string toString() { result = "VariableParent" }
16061646
}

0 commit comments

Comments
 (0)