add mpremote fs tree command to show a tree of the device's files

[Josverl]

while working on mpremote rm -r I developed a desire to see a tree-view of files on the device.
#16994 (comment)

I roughed up some code based on my thinking , but wanted to check what other things I have not thought about.

currently :

• shows treeview from current path or specified path
• today uses the graph chars ("├── ", "└── ") ( not configurable)
• -v/--verbose adds the serial device name to the top of the tree
• -s/--size add a (human readable) size to the files only

other suggestions ?

$ mpremote resume tree -v /
tree :/
:/ on /dev/ttyACM0
├── flash
├── ramdisk
│   ├── a.py
│   ├── b.py
│   ├── bar
│   │   ├── aaa.py
│   │   ├── baz
│   │   │   ├── aaa.py
│   │   │   ├── bbbb.py
│   │   │   └── quux
│   │   │       ├── aaa.py
│   │   │       ├── bbbb.py
│   │   │       └── xen
│   │   │           └── aaa.py
│   │   └── bbbb.py
│   └── foo
│       ├── aa.py
│       └── ba.py
└── sd
    ├── System Volume Information
    │   ├── IndexerVolumeGuid
    │   └── WPSettings.dat
    ├── hello.py
    ├── large.txt
    ├── log.txt
    └── pyproject.toml

no PR yet : sneakpeak possible

[andrewleech]

Nice one, I literally wanted something like this just yesterday!
I think size can be incredibly helpful but will slow it down on larger filesystems and isn't always needed; making it an option would be ideal I feel.

[DavesCodeMusings]

Recursive listing would be handy. I don't necessarily need to see a tree view with graph characters. Just a simple ls -R looking output would be fine.

[Josverl]

Agree that a recursive directory listing would be nice as well
personally I would prefer dir -r over ls -lRs, due to usability and personal muscle memory, but we could bake our sensible defaults .

[mattytrentini]

FWIW I've been considering giving mpremote the rich/textual overhaul for some time now, but there are pros/cons to introducing that dependency.

However, it would mean that a Tree implementation would be very easy.

[davefes]

the rich/textual

When I moved from rshell to mpremote I missed the ability to just cp everything on root. My work-around is to have a home directory on the device. My searching seemed to suggest that rich/textual was needed to allow one to emulate that process. Correct?

[Josverl]

cant see why a cooler UI is needed to copy file.

mkdir backup
mpremote fs cp -rv :/ ./backup

[Josverl]

yes Textual has a nice tree , but current implementation is ~20 lines , so not daunting either

[mattytrentini]

Oh, sure, if it was only ever to be used for tree, no. But it could also improve the progress bars - and could even be a fairly interactive TUI (file browser while the REPL is active?) if that was desirable...

[Josverl]

I could not find decent docs on the os.stat / os.stat_result for micropython, So I tried my best to see what is available.
Does this make sense ?:
with - 6 size: Size of file in bytes as the most relevant attribute ,
or is - 8 mtime: Last modification tim also a good candidate ( assuming time sync)

stat_result : TypeAlias = Tuple[int, int, int, int, int, int, int, int, int, int]
"""A 10-tuple containing the result of a stat call.
The tuple contains the following values:
- 0 mode: File mode (permissions and type)
- 1 ino: always 0
- 2 dev: always 0
- 3 nlink: always 0
- 4 uid: always 0
- 5 gid: always 0
- 6 size: Size of file in bytes
- 7 atime: Last access time (in seconds since epoch)
- 8 mtime: Last modification time (in seconds since epoch)
- 9 ctime: Last status change time (in seconds since epoch)
"""

🙊never mind for this context,
mpremote Transport.fs_listdir usesos.ilistdir which promotes a speedy listing with just the attributes: name , mode , ino and size

[Josverl]

-v for verbose
-s for size

$ mpremote resume tree -sv /
tree :/
:/ on /dev/ttyACM0
├── [  10B] a.py
├── [ 1.9K] b.py
├── backup
│   ├── [  10B] a.py
│   ├── [ 1.9K] b.py
│   ├── foo
│   │   ├── [   0B] aa.py
│   │   └── [   0B] ba.py
│   └── lib
│       ├── [   0B] bar.py
│       └── [   0B] foo.py
├── [   0B] bar.py
├── foo
│   ├── [   0B] aa.py
│   └── [   0B] ba.py
├── [   0B] foo.py
├── lib
│   ├── [   0B] bar.py
│   └── [   0B] foo.py
└── ramdisk
    ├── [   0B] bar.py
    ├── [   0B] foo.py
    └── lib
        ├── [   0B] lib_bar.py
        └── [   0B] lib_foo.py

Draft PR: #17112