feat: add ascii repr in the console

[apkrelling]

Pull Request description

Add basic ascii AST visualization function and quick example.

This aims to help solve #22 .

How to test these changes:

run the docs/tutorials/ascii_ast_example.ipynb notebook

Pull Request checklists

This PR is a:

• [ ] bug-fix
• [X] new feature
• [ ] maintenance

About this PR:

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

Author's checklist:

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

Additional information

png visualization:

ascii visualization:

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 .

[review-notebook-app[bot]]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[apkrelling]

Hey @xmnlab , I've made the changes we discussed:

• for the type hints, used from __future__ import annotations and from typing import Any
• reduced the number of indentation levels as you suggested
• emptied the poetry.lock file so there wouldn't be conflits (or it would be easier to solve any conflicts)
• used nodes=list(nodes)

[apkrelling]

Reopening the pull request.

[apkrelling]

Changes:

• removed the notebook example (to be updated and added later)
• looked into other forms of doing ascii representation - such as dot-to-ascii - but asciinet/graph_to_ascii was more suitable due to the tree layout
• traverse_ast func now is suitable for both list and dict ASTs
• overloaded graph_to_ascii func to be able to deal with repeated node names.

How to test these changes:

from astx.viz import traverse_ast, visualize, graph_to_ascii
import astx

block = astx.Block()
decl_a = astx.VariableDeclaration("a", type_=astx.Int32, value=astx.LiteralInt32(1))
decl_b = astx.VariableDeclaration("b", type_=astx.Int32, value=astx.LiteralInt32(1))
var_a = astx.Variable("a")
var_b = astx.Variable("b")
sum_op = astx.BinaryOp(op_code="+", lhs=var_a, rhs=var_b)
block.append(decl_a)
block.append(decl_b)
block.append(sum_op)
visualize(block.get_struct(simplified=True)) # png viz

graph = traverse_ast(block.get_struct(simplified=True))
graph = graph_to_ascii(graph) # ascii viz

Pull Request checklists

This PR is a:

• [ ] bug-fix
• [X] new feature
• [ ] maintenance

About this PR:

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

Author's checklist:

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

Additional information

ascii visualization:

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]

@xmnlab , here's an update:

• added asciinet and msgpack to poetry
• split traverse_ast into traverse_ast_ascii and traverse_ast_png
• added the graph_to_ascii func in https://github.com/arxlang/astx/blob/main/src/astx/base.py#L161
• changed the return of graph_to_ascii_overload from None to str.

How to test these changes:

from astx.viz import traverse_ast, visualize, graph_to_ascii
import astx

block = astx.Block()
decl_a = astx.VariableDeclaration("a", type_=astx.Int32, value=astx.LiteralInt32(1))
decl_b = astx.VariableDeclaration("b", type_=astx.Int32, value=astx.LiteralInt32(1))
var_a = astx.Variable("a")
var_b = astx.Variable("b")
sum_op = astx.BinaryOp(op_code="+", lhs=var_a, rhs=var_b)
block.append(decl_a)
block.append(decl_b)
block.append(sum_op)
visualize(block.get_struct(simplified=True)) # png viz

dot_graph = traverse_ast(block.get_struct(simplified=True))
graph = graph_to_ascii(dot_graph) # ascii viz
print(graph)

[github-actions[bot]]

:tada: This PR is included in version 0.13.0 :tada:

The release is available on:

• 0.13.0
• GitHub release

Your semantic-release bot :package::rocket: