Description

File in git repo with space, shlex.split() make a longer list than accepted by PLS.

Reproduction

Create the file

mkdir test
cd test
git init
touch "file.txt badly formatted with more word than the 3 accepted by the code"

Just run pls and it raise ExecException: Could not parse Git status code.

The status can be wrong if components == 3

Expectation

Do not raise exception, perhaps log warning. And have a better split.

Resolution

• [x] 🙋 I would be interested in resolving this bug.

The following two commands make pls trapped:

$ mkdir -p /tmp/dir/qq
$ ln -s /tmp/dir/qq pp
$ pls
Traceback (most recent call last):
  File "/home/george/venv/_pls/bin/pls", line 8, in <module>
    sys.exit(main())
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/main.py", line 16, in main
    node_map, node_list = read_input()
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/fs/list.py", line 82, in read_input
    node_list.sort(key=sort_key, reverse=args.sort.endswith("-"))
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/fs/list.py", line 26, in sort_key
    key = node.sort_keys[args.sort.rstrip("-")]
  File "/usr/lib64/python3.10/functools.py", line 981, in __get__
    val = self.func(instance)
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/models/node.py", line 207, in sort_keys
    "type": self.type_char,
  File "/usr/lib64/python3.10/functools.py", line 981, in __get__
    val = self.func(instance)
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/models/mixins/type.py", line 50, in type_char
    return type_char_map[self.node_type]
  File "/usr/lib64/python3.10/functools.py", line 981, in __get__
    val = self.func(instance)
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/models/mixins/type.py", line 41, in node_type
    self.populate_dest()
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/models/mixins/type.py", line 69, in populate_dest
    self.dest_node = self.__class__(name=link_path, path=link)
  File "/home/george/venv/_pls/lib64/python3/site-packages/pls/models/mixins/git.py", line 28, in __init__
    self.path_wrt_git = self.path.relative_to(state.git_root)
  File "/usr/lib64/python3.10/pathlib.py", line 816, in relative_to
    raise ValueError("{!r} is not in the subpath of {!r}"
ValueError: '/tmp/dir/qq' is not in the subpath of '/home/george' OR one path is relative and the other is absolute.

Problem

Forgive me for opening another issue so quickly! This is an excellent application, and I've been enjoying using it. I can't seem to find documentation about how to change the default directory icon or color.

I have tried an extension node with an empty string, and a pattern node which looks for \ or / at the end of the name. Neither have worked, and without any examples in the documentation, I'm assuming this idea is not supported at the moment.

Description

It would be very nice to be able to specify directories either by pattern or extension, or some other mechanism within .pls.yml. This would allow the user to change the default directory color or icon.

Alternatives

What I am trying to do is match the color output of pls to the color output of ls, which uses the LS_COLORS environmental variable. pls could make the default output colors use this variable, but it is not always set for users. On macOS, it is only used if the users use the GNU-based ls, for example. I think a simpler solution would be to make it easier to change directory colors, and allow the user to input any other extensions or patterns they want. That part is already very simple thanks to the excellent config!

Additional context

My apologies if this is already supported! I looked long and hard through the documentation but failed to find the solution to this.

Implementation

• [ ] 🙋 I would be interested in implementing this feature.

Description

Installed pls via the pip --user install.

Specifically:

pip install --user --upgrade pls

When I run it complains about You may need to add PYTHONIOENCODING=utf-8 to your environment and even if I do that, it doesn't work.

Reproduction

using zsh

1. export PYTHONIOENCODING=utf8
2. pls (gives error)
3. export PYTHONIOENCODING=utf-8
4. pls (gives error)
5. export PYTHONIOENCODING="utf-8"
6. pls (gives error)
7. export PYTHONIOENCODING="utf8"
8. pls (gives error)

Expectation

pls to run without error

Environment

• Device: Desktop
• OS: Fedora 34
• Browser: N/A
• Version: pls 1.11.1
• Other info:

Additional context

the actual commands/errors:

$ export PYTHONIOENCODING=utf-8 $ pls
Traceback (most recent call last): File "/home/ermesa/.local/bin/pls", line 8, in sys.exit(main()) File "/home/ermesa/.local/lib/python3.9/site-packages/pls/main.py", line 31, in main write_output(node_list) File "/home/ermesa/.local/lib/python3.9/site-packages/pls/table/table.py", line 116, in write_output console.print(table) File "/home/ermesa/.local/lib/python3.9/site-packages/rich/console.py", line 1637, in print self._buffer.extend(new_segments) File "/home/ermesa/.local/lib/python3.9/site-packages/rich/console.py", line 837, in exit self._exit_buffer() File "/home/ermesa/.local/lib/python3.9/site-packages/rich/console.py", line 795, in _exit_buffer self._check_buffer() File "/home/ermesa/.local/lib/python3.9/site-packages/rich/console.py", line 1929, in _check_buffer self.file.write(text) UnicodeEncodeError: 'utf-8' codec can't encode character '\udccf' in position 99: surrogates not allowed *** You may need to add PYTHONIOENCODING=utf-8 to your environment ***

Resolution

• [ ] 🙋 I would be interested in resolving this bug.

I don't know if it has compatibility with pwsh (PowerShell 7.2.1), but it would be nice.

❯ pls
Traceback (most recent call last):
  File "C:\Users\fernando\AppData\Local\Programs\Python\Python310\lib\runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "C:\Users\fernando\AppData\Local\Programs\Python\Python310\lib\runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\Scripts\pls.exe\__main__.py", line 7, in <module>
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\site-packages\pls\main.py", line 16, in main
    nodes = read_input()
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\site-packages\pls\fs\list.py", line 82, in read_input
    all_nodes.sort(key=sort_key, reverse=args.sort == SortOrder.DESC)
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\site-packages\pls\fs\list.py", line 31, in sort_key
    prefix = "0" if node.node_type == NodeType.DIR else "1"
  File "C:\Users\fernando\AppData\Local\Programs\Python\Python310\lib\functools.py", line 981, in __get__
    val = self.func(instance)
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\site-packages\pls\models\node.py", line 82, in node_type
    node_type = get_node_type(self.path)
  File "C:\Users\fernando\AppData\Roaming\Python\Python310\site-packages\pls\fs\stats.py", line 130, in get_node_type
    raise ExecException("Could not determine type of the node.")
pls.exceptions.ExecException: Could not determine type of the node.

Steam uses a broken symlink in the home folder for backwards compatibility:

.steampath -> /home/username/.steam/sdk32/steam

pls crashes while trying to read this

multiprocessing.pool.RemoteTraceback: 
"""
Traceback (most recent call last):
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 125, in worker
    result = (True, func(*args, **kwds))
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 48, in mapstar
    return list(map(*args))
  File "/usr/lib/python3.10/site-packages/pls/fs/list.py", line 43, in parse_nodes
    return Node(node_name, path=node_path)
  File "/usr/lib/python3.10/site-packages/pls/models/node.py", line 26, in __init__
    self.stat = path.stat()
  File "/usr/lib/python3.10/pathlib.py", line 1095, in stat
    return self._accessor.stat(self, follow_symlinks=follow_symlinks)
FileNotFoundError: [Errno 2] No such file or directory: '/home/username/.steampath'
"""

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/bin/pls", line 33, in <module>
    sys.exit(load_entry_point('pls==1.6.0', 'console_scripts', 'pls')())
  File "/usr/lib/python3.10/site-packages/pls/main.py", line 16, in main
    nodes = read_input()
  File "/usr/lib/python3.10/site-packages/pls/fs/list.py", line 55, in read_input
    comp_nodes = pool.map(parse_nodes, all_nodes)
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 364, in map
    return self._map_async(func, iterable, mapstar, chunksize).get()
  File "/usr/lib/python3.10/multiprocessing/pool.py", line 771, in get
    raise self._value
FileNotFoundError: [Errno 2] No such file or directory: '/home/username/.steampath'

Problem

I couldn't find a nerd font icon for excel spreadsheets (.xlsx or .xls), but I found a nice icon I would have liked to use here.

Description

My understanding is that this would require 2 things to be implemented:

1. a pls_assets folder to contain the icon images in either png or svg format
2. a way to point to the icon image in the .pls.yml configuration file

I don't know if this is feasible, but it would be great!

Alternatives

I couldn't find an alternative way to solve the above problem.

Implementation

• [ ] 🙋 I would be interested in implementing this feature.

Description

All the folders have ? icon (attached screenshot) , is this the default icon? Am I missing something?

Reproduction

1. pip install pls
2. type in pls
3. See the icons.

Expectation

Folders should have a icon based on name (for common folders) or have just a folder icon, but seeing question mark.

Screenshots

Environment

• Device: Macbook Pro m1
• OS: MacOs Monterey (12.5)
• Version: 5.3.0

Resolution

• [ ] 🙋 I would be interested in resolving this bug.

Description

pls * or pls <dir1> <dir2> currently shows the help and an error. It would be great if pls could show the contents of multiple directories in one command like ls can.

Implementation

• [ ] 🙋 I would be interested in implementing this feature.

Description

is_dir can throw an OSError, which is not catched.

Traceback (most recent call last):
  File "/home/grzegorzmilka/.local/bin/pls", line 8, in <module>
    sys.exit(main())
  File "/home/grzegorzmilka/.local/pipx/venvs/pls/lib/python3.9/site-packages/pls/main.py", line 102, in main
    node_map, node_list = read_input()
  File "/home/grzegorzmilka/.local/pipx/venvs/pls/lib/python3.9/site-packages/pls/fs/list.py", line 72, in read_input
    node_map = {
  File "/home/grzegorzmilka/.local/pipx/venvs/pls/lib/python3.9/site-packages/pls/fs/list.py", line 75, in <dictcomp>
    if (parsed_node := parse_node(parent_path, node))
  File "/home/grzegorzmilka/.local/pipx/venvs/pls/lib/python3.9/site-packages/pls/fs/list.py", line 38, in parse_node
    if node_path.is_dir():
  File "/usr/lib/python3.9/pathlib.py", line 1439, in is_dir
    return S_ISDIR(self.stat().st_mode)
  File "/usr/lib/python3.9/pathlib.py", line 1232, in stat
    return self._accessor.stat(self)
OSError: [Errno 126] Required key not available: '/home/grzegorzmilka/target'

Reproduction

I don't know how to reproduce this. target is a symbolic link to a directory, which is inaccessible at the time of the call.

Expectation

No error is thrown. Maybe the directory doesn't get any special symbol or is marked with red.

Environment

• Device: Desktop
• OS: Debian
• Version: 4.0.1

Description

In documentation as well as output, when pls refers to ctime, it characterizes that time as the file's creation time. This is a common misconception. On most unix and unix-like operating systems, ctime is The inode's "change time." In fact I believe there is no POSIX standard to track file creation time (sometimes called birthtime).

Some filesystems (e.g., APFS & HFS+ on macOS) do report file creation time, where as others (e.g., ext4 on Linux) do not.

How does that differ from mtime you may ask. mtime (as well as ctime) is updated when the contents of the inode are changed. If only the file's metadata (e.g., ownership, permissions, etc.) are changed, then only the inode's ctime will be updated.

Reproduction

1. create a file: e.g., ls -l > listing.txt
2. stat it
3. pls -d ctime -d mtime -d atime the file & see the respective times match
4. chmod +x the file
5. stat and pls the file as before
6. see that only ctime has been updated, which is clearly not the file's creation time

Expectation

In documentation as well as output ctime should be referred to as "change time" or simply ctime

Screenshots

Environment

maOS:

ProductName:	macOS
ProductVersion:	12.3.1
BuildVersion:	21E258

Ubuntu:

DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=20.04
DISTRIB_CODENAME=focal
DISTRIB_DESCRIPTION="Ubuntu 20.04.4 LTS"

Additional context

Resolution

• [ ] 🙋 I would be interested in resolving this bug.

Bumps gitpython from 3.1.28 to 3.1.30.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps setuptools from 65.4.1 to 65.5.1.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

• cleaned up imports
• simplified conditionals
• updated an f-string

Description

Clean up of code using isort, pylint and flynt

Checklist

• [X ] My pull request has a descriptive title (not a vague title like Update index.md).
• [X ] My pull request targets the default branch of the repository (main) or a parent feature branch.
• [ X] My commit messages follow best practices.
• [ X] My code follows the established code style of the repository.
• [ X] I added or updated tests for the changes I made (if applicable).
• [ NA] I added or updated documentation (if applicable).
• [X ] I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Bumps certifi from 2022.9.24 to 2022.12.7.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps jsonschema from 4.16.0 to 4.17.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Bumps ipython from 8.5.0 to 8.7.0.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.