zwoop commented on code in PR #13126: URL: https://github.com/apache/trafficserver/pull/13126#discussion_r3186013417
########## tools/hrw4u/src/ast_visitor.py: ########## @@ -0,0 +1,309 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations + +from hrw4u.hrw4uVisitor import hrw4uVisitor +from hrw4u.ast_nodes import ( Review Comment: If we get the __all__ in ast_nodes.py, then we can write this a safe (and much shorter) ``` from hrw4u.ast_nodes import * ``` This repeats later too in the tests. ########## tools/hrw4u/src/ast_nodes.py: ########## @@ -0,0 +1,180 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations Review Comment: Can we have an __all__ here with all public symbols, allowing for a safe (and shorter) import * ? ########## tools/hrw4u/tests/test_ast_visitor.py: ########## @@ -0,0 +1,764 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from hrw4u.ast_nodes import ( Review Comment: Again, a really long import... Can we just import * ? Of course, this implies the __all__ declaration as mentioned before. ########## tools/hrw4u/src/ast_visitor.py: ########## @@ -0,0 +1,309 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations + +from hrw4u.hrw4uVisitor import hrw4uVisitor +from hrw4u.ast_nodes import ( + HRW4UAST, + Section, + Assignment, + FunctionCall, + Break, + Target, + IfBlock, + ElifBranch, + BoolLiteral, + Comparison, + LogicalOp, + NotOp, + IdentCondition, + ProcParam, + VarDecl, + VarSection, + UseDirective, + ProcedureDecl, + LiteralStringValue, + IdentValue, + IPValue, + ParamRef, + RegexValue, +) + + +class ASTVisitor(hrw4uVisitor): + """ANTLR visitor that walks an HRW4U parse tree and produces an AST for HRW4U.""" + + # Only visitProgram is overridden from the ANTLR visitor interface; + # all other traversal uses private _visit_* helpers so that each + # method has an explicit return type and full control over how + # child results are assembled into parent AST nodes. + + def visitProgram(self, ctx): Review Comment: I *think* (but can't easily check now), that the existing visitor implementation tries to use appropriate return types in class declarations. So it'd be like ``` def visitProgram(self, ctx) -> HRW4UAST: ... def _visit_use_directive(self, ctx) -> UseDirective: ... def _visit_procedure_decl(self, ctx) -> ProcedureDecl: ... ``` etc. Doesn't make noticeable difference, but originally I tried to use as much modern Python3.x declaration and stronger typing. ########## tools/hrw4u/src/ast_visitor.py: ########## @@ -0,0 +1,309 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations + +from hrw4u.hrw4uVisitor import hrw4uVisitor +from hrw4u.ast_nodes import ( + HRW4UAST, + Section, + Assignment, + FunctionCall, + Break, + Target, + IfBlock, + ElifBranch, + BoolLiteral, + Comparison, + LogicalOp, + NotOp, + IdentCondition, + ProcParam, + VarDecl, + VarSection, + UseDirective, + ProcedureDecl, + LiteralStringValue, + IdentValue, + IPValue, + ParamRef, + RegexValue, +) + + +class ASTVisitor(hrw4uVisitor): + """ANTLR visitor that walks an HRW4U parse tree and produces an AST for HRW4U.""" + + # Only visitProgram is overridden from the ANTLR visitor interface; + # all other traversal uses private _visit_* helpers so that each + # method has an explicit return type and full control over how + # child results are assembled into parent AST nodes. + + def visitProgram(self, ctx): + items = [] + for item in ctx.programItem(): + if item.useDirective() is not None: + items.append(self._visit_use_directive(item.useDirective())) + elif item.procedureDecl() is not None: + items.append(self._visit_procedure_decl(item.procedureDecl())) + elif item.section() is not None: + items.append(self._visit_section(item.section())) + elif item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled programItem alternative at line {item.start.line}") + return HRW4UAST(body=tuple(items)) + + def _visit_use_directive(self, ctx): + return UseDirective( + spec=ctx.QUALIFIED_IDENT().getText(), + line=ctx.start.line, + ) + + def _visit_procedure_decl(self, ctx): + name = ctx.QUALIFIED_IDENT().getText() + params = () + if ctx.paramList(): + params = tuple(self._visit_proc_param(p) for p in ctx.paramList().param()) + body = tuple(self._visit_body(ctx.block().blockItem())) + return ProcedureDecl(name=name, params=params, body=body, line=ctx.start.line) + + def _visit_proc_param(self, ctx): + name = ctx.IDENT().getText() + default = self._extract_value(ctx.value()) if ctx.value() else None + return ProcParam(name=name, default=default, line=ctx.start.line) + + def _visit_section(self, ctx): + if ctx.varSection() is not None: + return self._visit_var_section(ctx.varSection(), "txn") + if ctx.sessionVarSection() is not None: + return self._visit_var_section(ctx.sessionVarSection(), "session") + name = ctx.name.text + body = self._visit_body(ctx.sectionBody()) + return Section(type=name, body=tuple(body), line=ctx.start.line) + + def _visit_var_section(self, ctx, scope): + decls = [] + for var_item in ctx.variables().variablesItem(): + if var_item.variableDecl() is not None: + decls.append(self._visit_var_decl(var_item.variableDecl())) + elif var_item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled variablesItem alternative at line {var_item.start.line}") + return VarSection(scope=scope, declarations=tuple(decls), line=ctx.start.line) + + def _visit_var_decl(self, ctx): + return VarDecl( + name=ctx.name.text, + type_name=ctx.typeName.text, + slot=int(ctx.slot.text) if ctx.slot else None, + line=ctx.start.line, + ) + + def _visit_body(self, items): + """Shared helper for sectionBody and blockItem lists.""" + result = [] + for item in items: + if item.statement() is not None: + result.append(self._visit_statement(item.statement())) + elif item.conditional() is not None: + result.append(self._visit_conditional(item.conditional())) + elif item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled body item alternative at line {item.start.line}") + return result + + def _visit_statement(self, ctx): + line = ctx.start.line + if ctx.BREAK(): + return Break(line=line) + if ctx.functionCall(): + return self._visit_function_call(ctx.functionCall()) + if ctx.EQUAL(): + target = Target.from_dotted(ctx.lhs.text) + value = self._extract_value(ctx.value()) + return Assignment(target=target, operator="=", value=value, line=line) + if ctx.PLUSEQUAL(): + target = Target.from_dotted(ctx.lhs.text) + value = self._extract_value(ctx.value()) + return Assignment(target=target, operator="+=", value=value, line=line) + if ctx.op: + return FunctionCall(name=ctx.op.text, args=(), line=line) + raise ValueError(f"Unhandled statement alternative at line {line}") + + def _visit_function_call(self, ctx): + name = ctx.funcName.text + args = () + if ctx.argumentList(): + args = tuple(self._extract_value(v) for v in ctx.argumentList().value()) + return FunctionCall(name=name, args=args, line=ctx.start.line) + + def _extract_value(self, ctx): + if ctx.number is not None: + return int(ctx.number.text) + if ctx.str_ is not None: + return LiteralStringValue(raw=ctx.str_.text[1:-1]) + if ctx.TRUE(): + return True + if ctx.FALSE(): + return False + if ctx.ident is not None: + return IdentValue(raw=ctx.ident.text) + if ctx.ip(): + return IPValue(raw=ctx.ip().getText()) + if ctx.iprange(): + return tuple(IPValue(raw=ip.getText()) for ip in ctx.iprange().ip()) + if ctx.paramRef(): + return ParamRef(raw=ctx.paramRef().IDENT().getText()) + raise ValueError(f"Unhandled value alternative at line {ctx.start.line}") + + def _visit_conditional(self, ctx): + if_stmt = ctx.ifStatement() + condition = self._visit_condition(if_stmt.condition()) + block = if_stmt.block() + body = tuple(self._visit_body(block.blockItem())) if block else () + + elif_branches = [] + for elif_ctx in ctx.elifClause(): + elif_cond = self._visit_condition(elif_ctx.condition()) + elif_block = elif_ctx.block() + elif_body = tuple(self._visit_body(elif_block.blockItem())) if elif_block else () + elif_branches.append(ElifBranch( + condition=elif_cond, + body=elif_body, + line=elif_ctx.start.line, Review Comment: Yeah, so this black-format style repeats. I'd much prefer not to. ########## tools/hrw4u/src/ast_visitor.py: ########## @@ -0,0 +1,309 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations + +from hrw4u.hrw4uVisitor import hrw4uVisitor +from hrw4u.ast_nodes import ( + HRW4UAST, + Section, + Assignment, + FunctionCall, + Break, + Target, + IfBlock, + ElifBranch, + BoolLiteral, + Comparison, + LogicalOp, + NotOp, + IdentCondition, + ProcParam, + VarDecl, + VarSection, + UseDirective, + ProcedureDecl, + LiteralStringValue, + IdentValue, + IPValue, + ParamRef, + RegexValue, +) + + +class ASTVisitor(hrw4uVisitor): + """ANTLR visitor that walks an HRW4U parse tree and produces an AST for HRW4U.""" + + # Only visitProgram is overridden from the ANTLR visitor interface; + # all other traversal uses private _visit_* helpers so that each + # method has an explicit return type and full control over how + # child results are assembled into parent AST nodes. + + def visitProgram(self, ctx): + items = [] + for item in ctx.programItem(): + if item.useDirective() is not None: + items.append(self._visit_use_directive(item.useDirective())) + elif item.procedureDecl() is not None: + items.append(self._visit_procedure_decl(item.procedureDecl())) + elif item.section() is not None: + items.append(self._visit_section(item.section())) + elif item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled programItem alternative at line {item.start.line}") + return HRW4UAST(body=tuple(items)) + + def _visit_use_directive(self, ctx): + return UseDirective( + spec=ctx.QUALIFIED_IDENT().getText(), + line=ctx.start.line, + ) Review Comment: Hmmm, I guess yapf doesn't fix these lines? But I really prefer (and seriously dislike pythons 80 charlines) longer lines, I think I set yapf to 132 characters. As such, shouldn't this fit on one line, e.g. ``` return UseDirective(spec=ctx.QUALIFIED_IDENT().getText(), line=ctx.start.line) ``` maybe it's the trailing, after the second parameter to the ctor ? Since I generally prefer long lines (up to 132 characters), I typically don't do these multi-line calls like this before closing )'s. If possible, I'd prefer to stick with this format, to keep the code consistently. Consistency is most important for reading code. Fwiw: ``` ±master⚡ » grep 132 ./.style.yapf column_limit=132 ``` ########## tools/hrw4u/src/ast_visitor.py: ########## @@ -0,0 +1,309 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. + +from __future__ import annotations + +from hrw4u.hrw4uVisitor import hrw4uVisitor +from hrw4u.ast_nodes import ( + HRW4UAST, + Section, + Assignment, + FunctionCall, + Break, + Target, + IfBlock, + ElifBranch, + BoolLiteral, + Comparison, + LogicalOp, + NotOp, + IdentCondition, + ProcParam, + VarDecl, + VarSection, + UseDirective, + ProcedureDecl, + LiteralStringValue, + IdentValue, + IPValue, + ParamRef, + RegexValue, +) + + +class ASTVisitor(hrw4uVisitor): + """ANTLR visitor that walks an HRW4U parse tree and produces an AST for HRW4U.""" + + # Only visitProgram is overridden from the ANTLR visitor interface; + # all other traversal uses private _visit_* helpers so that each + # method has an explicit return type and full control over how + # child results are assembled into parent AST nodes. + + def visitProgram(self, ctx): + items = [] + for item in ctx.programItem(): + if item.useDirective() is not None: + items.append(self._visit_use_directive(item.useDirective())) + elif item.procedureDecl() is not None: + items.append(self._visit_procedure_decl(item.procedureDecl())) + elif item.section() is not None: + items.append(self._visit_section(item.section())) + elif item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled programItem alternative at line {item.start.line}") + return HRW4UAST(body=tuple(items)) + + def _visit_use_directive(self, ctx): + return UseDirective( + spec=ctx.QUALIFIED_IDENT().getText(), + line=ctx.start.line, + ) + + def _visit_procedure_decl(self, ctx): + name = ctx.QUALIFIED_IDENT().getText() + params = () + if ctx.paramList(): + params = tuple(self._visit_proc_param(p) for p in ctx.paramList().param()) + body = tuple(self._visit_body(ctx.block().blockItem())) + return ProcedureDecl(name=name, params=params, body=body, line=ctx.start.line) + + def _visit_proc_param(self, ctx): + name = ctx.IDENT().getText() + default = self._extract_value(ctx.value()) if ctx.value() else None + return ProcParam(name=name, default=default, line=ctx.start.line) + + def _visit_section(self, ctx): + if ctx.varSection() is not None: + return self._visit_var_section(ctx.varSection(), "txn") + if ctx.sessionVarSection() is not None: + return self._visit_var_section(ctx.sessionVarSection(), "session") + name = ctx.name.text + body = self._visit_body(ctx.sectionBody()) + return Section(type=name, body=tuple(body), line=ctx.start.line) + + def _visit_var_section(self, ctx, scope): + decls = [] + for var_item in ctx.variables().variablesItem(): + if var_item.variableDecl() is not None: + decls.append(self._visit_var_decl(var_item.variableDecl())) + elif var_item.commentLine() is not None: + pass + else: + raise ValueError(f"Unhandled variablesItem alternative at line {var_item.start.line}") + return VarSection(scope=scope, declarations=tuple(decls), line=ctx.start.line) + + def _visit_var_decl(self, ctx): + return VarDecl( + name=ctx.name.text, + type_name=ctx.typeName.text, + slot=int(ctx.slot.text) if ctx.slot else None, + line=ctx.start.line, + ) Review Comment: Same here I think? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
