Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davep/textual-astview
A Textual-based Python AST viewing widget library and application
https://github.com/davep/textual-astview
Last synced: 20 days ago
JSON representation
A Textual-based Python AST viewing widget library and application
- Host: GitHub
- URL: https://github.com/davep/textual-astview
- Owner: davep
- License: mit
- Created: 2022-12-19T22:40:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-10T20:12:23.000Z (about 1 year ago)
- Last Synced: 2024-08-27T09:08:54.867Z (3 months ago)
- Language: Python
- Size: 2.09 MB
- Stars: 76
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
Awesome Lists containing this project
- awesome-textualize-projects - Astview - A Textual-based Python AST viewing widget library and application. (Community / Third Party Applications)
README
# textual-astview
[](https://badge.fury.io/py/textual-astview)
[](https://www.youtube.com/watch?v=wQlfhdyIG8Y)
[View the code in action on YouTube](https://www.youtube.com/watch?v=wQlfhdyIG8Y)
## Introduction
This is a combination of a [Textual](https://textual.textualize.io/) widget
library and also a command line tool. The aim is to provide tools for
displaying and exploring the [Python
AST](https://docs.python.org/3/library/ast.html).
## It's early days
This is a very early release of this code, it's still very much a work in
progress. This means things may change and break; it's also sitting atop
Textual which is, of course, still undergoing rapid development. As much as
possible I'll try and ensure that it's always working with the latest stable
release of Textual.
Also, because it's early days... while I love the collaborative aspect of
FOSS, I'm highly unlikely to be accepting any non-trivial PRs at the moment.
Developing this is a learning exercise for me, it's a hobby project, and
it's also something to help me further test Textual (disclaimer for those
who may not have gathered, I am employed by
[Textualize](https://www.textualize.io/)).
On the other hand: I'm *very* open to feedback and suggestions so don't
hesitate to engage with me [in
Discussions](https://github.com/davep/textual-astview/discussions), or if
it's a bug,[in Issues](https://github.com/davep/textual-astview/issues). I
can't and won't promise that I'll take everything on board (see above about
hobby project, etc), but helpful input should help make this as useful as
possible in the longer term.
## Installing
The package can be installed with `pip` or related tools, for example:
```sh
$ pip install textual_astview
```
As well as the library (which I'll give some minimal documentation for below
-- hopefully more comprehensive documentation will follow eventually), a
command is also installed called `astare`. This can be used to load up and
explore a Python source file.
## The library
In the library you'll find the following Textual widgets:
### `ASTView`
This is the main AST tree view. Create it by passing a Python `Path` object
for the file you want it to display.
### `Source`
This is a widget that shows the source code for a Python file. Create this
by also passing it a Python `Path` object for the file you want it to
display. It, of course, only really makes sense to have it show the same
file as the `ASTView` it'll work in concert with.
### `NodeInfo`
This is a widget that is intended to be used as a footer bar, of sorts,
giving a summary of where an `ASTView` is focused.
## Putting the widgets together
The way they all work is far from final, so the best way to get an idea of
how to use them, right now, is to take a look at [the code for
`astare`](https://github.com/davep/textual-astview/blob/main/textual_astview/app/astare.py).
There's not a whole lot to it (right now anyway) so hopefully it'll be easy
enough to follow.
## Known issues
- The `Source` widget doesn't self-handle switches from dark/light mode
within a Textual app; this is down to a problem with Textual's `watch`
system not quite fully working yet. For now `Source` needs to be told to
switch by your own application code.
## TODO
If you're seeing this that means I decided to release so folk can have a
play. There's a bunch of stuff I still want to do but it can be out there
and available and then have this sorted.
- [X] Add some actual error checking around loading the file.
- [X] Test on Windows.
- [X] Test on GNU/Linux.
- [ ] Dial in the colour and style until I'm really happy with it.
- [ ] Add some styling options for `NodeInfo`.
- [ ] Think about which styles should end stay in `DEFAULT_CSS` and which
should go into an app-level CSS -- this might be a bit all over the
place right now.
- [ ] More navigation features.
- [ ] Lots of keyboard navigation coverage.
- [ ] Searching.
- [ ] Extend and test all the styling options.
- [X] Allow loading another file without leaving the app.
- [X] A more "rainbow" approach to highlighting the source and tree
position.
- [X] Add support for setting the [source style](https://pygments.org/styles/).
- [X] Add a dark/light mode toggle to `astare`.
- [ ] Better handle really long "paths" in `NodeInfo`.
- [X] In `astare` allow resizing of the panes.
- [ ] Look at making the rainbow highlight in the source more of an "onion"
style (try and use indentation columns to show the layers too).
- [ ] Add more muted labels to the tree, but perhaps place them behind a
verbosity switch so the tree doesn't get too cluttered.
- [ ] Keep on having fun hacking on it.
- [ ] Other stuff. I'm sure there's other stuff.
[//]: # (README.md ends here)