feat: create ForRangeExpr class

[apkrelling]

Pull Request description

This PR adds ForRangeExpr and modifies ForRangeLoop.
This PR is an attempt to solve #94 .

• added new ASTKind
• created ForRangeExpr class
• modified ForRangeLoop class to be compatible with ForRangeExpr
• updated __init__.py to include the new imports and classes in the __all__ list
• added the new classes visit methods in transpilers/python.py
• added test in tests/transpilers/test_python.py
• added test in tests/test_flows.py

How to test these changes

from astx.variables import Variable, InlineVariableDeclaration
from astx.blocks import Block
from astx.flows import ForRangeLoop, ForRangeExpr
from astx.datatypes import LiteralInt32
from astx.datatypes import Int32
from astx.modifiers import MutabilityKind

# Create a range expression from 0 to 6 with step 1
range_expr = ForRangeExpr(
    start=LiteralInt32(0),
    end=LiteralInt32(6),
    step=LiteralInt32(1)
)

# Variable declaration for the loop variable
loop_var = InlineVariableDeclaration(
    name="i",
    type_=Int32,
    mutability=MutabilityKind.mutable,
    value=LiteralInt32(1),
)
loop_var2 = Variable(name="i")

# Loop body
loop_body = Block(name="loop_body")

# Add statements to the loop body as needed
lit_2 = LiteralInt32(2)
basic_op = loop_var2 * lit_2
loop_body.append(basic_op)

# Create the ForRangeLoop using the range expression
for_loop = ForRangeLoop(
    variable=loop_var,
    range_expr=range_expr,
    body=loop_body,
)

Pull Request checklists

This PR is a:

• bug-fix
• new feature
• maintenance

About this PR:

• it includes tests.
• the tests are executed on CI.
• the tests generate log file(s) (path).
• pre-commit hooks were executed locally.
• this PR requires a project documentation update.

Author's checklist:

• I have reviewed the changes and it contains no misspelling.
• The code is well commented, especially in the parts that contain more
  complexity.
• New and old tests passed locally.

Additional information

Reviewer's checklist

Copy and paste this template for your review's note:

## Reviewer's Checklist

- [ ] I managed to reproduce the problem locally from the `main` branch
- [ ] I managed to test the new changes locally
- [ ] I confirm that the issues mentioned were fixed/resolved .

[apkrelling]

The AST png and ascii representations for the code:

from astx.variables import Variable, InlineVariableDeclaration
from astx.blocks import Block
from astx.flows import ForRangeLoop, ForRangeExpr
from astx.datatypes import LiteralInt32
from astx.datatypes import Int32
from astx.modifiers import MutabilityKind

# Create a range expression from 0 to 10 with step 1
range_expr = ForRangeExpr(
    start=LiteralInt32(0),
    end=LiteralInt32(6),
    step=LiteralInt32(1)
)

# Variable declaration for the loop variable
loop_var = InlineVariableDeclaration(
    name="i",
    type_=Int32,
    mutability=MutabilityKind.mutable,
    value=LiteralInt32(1),
)
loop_var2 = Variable(name="i")

# Loop body
loop_body = Block(name="loop_body")

# Add statements to the loop body as needed
lit_2 = LiteralInt32(2)
basic_op = loop_var2 * lit_2
loop_body.append(basic_op)

# Create the ForRangeLoop using the range expression
for_loop = ForRangeLoop(
    variable=loop_var,
    range_expr=range_expr,
    body=loop_body,
)

are:

[apkrelling]

Example usage for the transpiler:

# Create a ForRangeExpr node
range_expr = astx.ForRangeExpr(
    start=astx.LiteralInt32(0), 
    end=astx.LiteralInt32(10), 
    step=astx.LiteralInt32(1)
)

# Initialize the generator
generator = astx2py.ASTxPythonTranspiler()

# Generate Python code
generated_code = generator.visit(range_expr)
generated_code

output: range(0,10,1)

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[apkrelling]

Please note that on the issue I put a comment mentioning that the output of the transpiler should be something like result = [x * 2 for x in range(1,6)]. However, this should be the output for the ForRangeLoop (which is a Stmt), and not for the ForRangeExpr. Please let me know if it would be the case to create a new issue to set up the transpiler visit method for ForRangeLoop.

[apkrelling]

@xmn, after our discussions, here is the update for this PR:

• added new ASTKind
• created ForRangeExpr class
• got ForRangeLoop back to its original code
• changed class names: ForRangeLoop -> ForRangeLoopStmt, ForRangeExpr -> ForRangeLoopExpr
• updated __init__.py to include the new imports and classes in the __all__ list
• edited tests in tests/test_flows.py

[apkrelling]

@xmnlab , I noticed that

• in https://github.com/arxlang/astx/blob/main/docs/tutorials/for-loop.ipynb, in the second code cell, there's a ForRangeExpr used with a ForRangeLoop. With the changes I recently made to the repo, this code does not work anymore - that's the reason for the failing checks. I believe we should edit so it's just either ForRangeLoopStmt or ForRangeLoopExpr. What do you think?

[apkrelling]

ascii representation after changes:

png representation after changes:

Output of the transpiler method:
result = [ (i * 2) for i in range (0,6,1)]

[apkrelling]

Code used to test these changes:

from astx.variables import Variable, InlineVariableDeclaration
from astx.blocks import Block
from astx.flows import ForRangeLoopExpr
from astx.datatypes import LiteralInt32
from astx.datatypes import Int32
from astx.modifiers import MutabilityKind
import astx
from astx.transpilers import python as astx2py

# Variable declaration for the loop variable
loop_var = InlineVariableDeclaration(
    name="i",
    type_=Int32,
    mutability=MutabilityKind.mutable,
    value=LiteralInt32(1),
)

loop_var2 = Variable(name="i")

# Loop body
loop_body = Block(name="loop_body")

# Add statements to the loop body as needed
lit_2 = LiteralInt32(2)
basic_op = loop_var2 * lit_2
loop_body.append(basic_op)


# Create a range expression from 0 to 6 with step 1
for_expr = ForRangeLoopExpr(
    variable=loop_var,
    start=LiteralInt32(0),
    end=LiteralInt32(6),
    step=LiteralInt32(1),
    body=loop_body
)
for_expr

generator = astx2py.ASTxPythonTranspiler()
generated_code = generator.visit(for_expr)
print(generated_code)

[xmnlab]

thank you @apkrelling !
That looks good!

I am merging this PR, and I will play a bit with that and maybe open a follow-up PR with some small changes and I will fix the notebook as well.

thanks, and sorry for messing with the issue XD

[github-actions]

🎉 This PR is included in version 0.16.0 🎉

The release is available on:

• 0.16.0
• GitHub release

Your semantic-release bot 📦🚀