Added FuncAlias #5366

anki-code · 2024-04-25T16:57:55Z

Goals

Make callable aliases transparent.
Catch errors in callable aliases and show the name of the source.
Show additional attributes: thredable, capturable.
Closes Show alias function description using superhelp #5266

Exception

Before

aliases['cd']
# <function xonsh.dirstack.cd>

aliases['trace']
# <function xonsh.aliases.trace>

aliases['null'] = lambda: 1/0
null
# ZeroDivisionError: division by zero

@aliases.register('catch')
@aliases.register('me')
@aliases.register('if')
@aliases.register('you')
@aliases.register('can')
def _exc(args, stdin, stdout):
    for line in stdin.readlines():
        print(line.strip() + '!', file=stdout, flush=True)
    return 1/0 if 'i' in $__ALIAS_NAME else 0

echo hey | catch | me | if | you | can
# ZeroDivisionError: division by zero      <--- ???
# hey!!!!!

After

aliases['cd']
# FuncAlias({'name': 'cd', 'func': 'cd'})

aliases['trace']
# FuncAlias({'name': 'trace', 'func': 'trace', '__xonsh_threadable__': False})

$XONSH_SHOW_TRACEBACK=False
$RAISE_SUBPROC_ERROR = False
aliases['null'] = lambda: 1/0
null
#Exception in thread {'cls': 'ProcProxyThread', 'name': 'Thread-15', 'func': FuncAlias({'name': 'null', 'func': '<lambda>'}), 'alias': 'null', 'pid': None}
#ZeroDivisionError: division by zero



@aliases.register('catch')
@aliases.register('me')
@aliases.register('if')
@aliases.register('you')
@aliases.register('can')
def _exc(args, stdin, stdout):
    for line in stdin.readlines():
        print(line.strip() + '!', file=stdout, flush=True)
    return 1/0 if 'i' in $__ALIAS_NAME else 0
echo hey | catch | me | if | you | can
# Exception in thread {'cls': 'ProcProxyThread', 'name': 'Thread-8', 'func': FuncAlias({'name': 'if', 'func': '_exc'}), 'alias': 'if', 'pid': None}
# ZeroDivisionError: division by zero
# hey!!!!!

Superhelp

Before

@aliases.register("hello")
def _alias_hello():
    """Show world."""
    print('world')

hello?
# No manual entry for hello

After

@aliases.register("hello")
def _alias_hello():
    """Show world."""
    print('world')

hello?
# FuncAlias({'name': 'hello', 'func': '_alias_hello'}):
# Show world.

For community

⬇️ Please click the 👍 reaction instead of leaving a +1 or 👍 comment

for more information, see https://pre-commit.ci

xonsh/aliases.py

for more information, see https://pre-commit.ci

anki-code · 2024-05-02T15:31:54Z

@jnoortheen what do you think?

jnoortheen · 2024-05-02T17:22:15Z

Catching errors can be made configurable? I am not sure about the behaviour. It already handles, error message when the return is a 3 tuple value (like [return_code, stdout_msg, stderr_msg])
The help on aliases can be made to work with current code as it is.

anki-code · 2024-05-02T18:43:09Z

@jnoortheen sorry, I'm not clearly understand what you mean. Please give me some pointers.

"message when the return is a 3 tuple value" - but the goal is to catch exception, isn't it?
You mean alias? - this is just a side fix of this pr.

jnoortheen · 2024-05-02T18:53:06Z

pls refer the tutorial secion - https://xon.sh/tutorial.html#callable-aliases

# Lastly, a 3-tuple return value can be used to include an integer
    # return code indicating failure (> 0 return code). In the previous
    # examples the return code would be 0/success.
    return (None, "I failed", 2)

Yes I mean the help(alias) function handling

anki-code · 2024-05-02T19:25:20Z

@jnoortheen Thank you for the link! Why we are talking about return if this PR is to capture the Exception and show what alias raised it?

jnoortheen · 2024-05-02T19:41:25Z

It shows the error message in a specific way. e.g. alias-name: error: msg. Also Hiding tracebacks should be configurable.

anki-code · 2024-05-07T22:55:06Z

@gforsyth It's ready to review. One question: what do you think is it possible to print full traceback with the error line?

gforsyth · 2024-05-07T23:02:07Z

what do you think is it possible to print full traceback with the error line?

Can you give me an example of what you're thinking of?

anki-code · 2024-05-07T23:11:25Z

@gforsyth yep, I mean when I'm doing this:

def f():
    1/0
class qwe:
    def __init__(self,g):
        self.f=g
    def __call__(self):
        self.f()
try:
    qwe(f)()
except Exception:
    raise

I have full traceback in Python:

Traceback (most recent call last):
  File "/private/tmp/1.py", line 9, in <module>
    qwe(f)()
  File "/private/tmp/1.py", line 7, in __call__
    self.f()
  File "/private/tmp/1.py", line 2, in f
    1/0
    ~^~
ZeroDivisionError: division by zero

But:

$XONSH_SHOW_TRACEBACK = True
@aliases.register('f')
def _f():
    1/0
echo f1f1f1 ; f ; echo f2f2f2

Returns only:

Traceback (most recent call last):
  File "/Users/pc/git/xonsh/xonsh/procs/proxies.py", line 475, in run
    r = self.f(self.args, sp_stdin, sp_stdout, sp_stderr, spec, spec.stack)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/pc/git/xonsh/xonsh/aliases.py", line 87, in __call__
    return self.func(*func_args)
           ^^^^^^^^^^^^^^^^^^^^^

gforsyth · 2024-05-08T13:37:33Z

There's probably a way to do that by intercepting the traceback and then adding to it with with_traceback(), but I haven't dug around in traceback mutations in a long while.

gforsyth

I haven't had time to figure out where this bug is coming from, but this PR introduces a strange behavior where we swallow the first traceback after setting $XONSH_SHOW_TRACEBACK=True

gil@stravaig ~ @ def _f():
................     1 / 0
................
gil@stravaig ~ @ aliases['f'] = _f
gil@stravaig ~ @ f
xonsh: For full traceback set: $XONSH_SHOW_TRACEBACK = True
ZeroDivisionError: division by zero
Exception in FuncAlias({'name': 'f', 'func': <function _f at 0x7def51916c20>})
gil@stravaig ~ @ $XONSH_SHOW_TRACEBACK = True
gil@stravaig ~ @ f    # <- Notice no output here
gil@stravaig ~ @ f
xonsh: To log full traceback to a file set: $XONSH_TRACEBACK_LOGFILE = <filename>
Traceback (most recent call last):
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/aliases.py", line 87, in __call__
    return self.func(*func_args)
  File "<stdin>", line 2, in _f
ZeroDivisionError: division by zero
Exception in FuncAlias({'name': 'f', 'func': <function _f at 0x7def51916c20>})

anki-code · 2024-05-08T14:29:50Z

@gforsyth I think this behavior is not from this PR. There is general issue around raising exception from alias and having hard exception from closed descriptor - #5393
I think this swallowing comes from the situation when descriptor is lost.
Could you please try to repeat 5393 on your main (not from this PR) xonsh session. The expect script pinned in the issue.

gforsyth · 2024-05-08T15:29:48Z

This is on current main:

gil@stravaig ~ @ xonfig
+-----------------------------+---------------------+
| xonsh                       | 0.16.0.dev91        |
| Git SHA                     | 4a2cfc64            |
| Commit Date                 | May 6 14:20:34 2024 |
| Python                      | 3.10.12             |
| PLY                         | 3.11                |
| have readline               | True                |
| prompt toolkit              | 3.0.39              |
| shell type                  | prompt_toolkit      |
| history backend             | json                |
| pygments                    | 2.16.1              |
| on posix                    | True                |
| on linux                    | True                |
| distro                      | ubuntu              |
| on wsl                      | False               |
| on darwin                   | False               |
| on windows                  | False               |
| on cygwin                   | False               |
| on msys2                    | False               |
| is superuser                | False               |
| default encoding            | utf-8               |
| xonsh encoding              | utf-8               |
| encoding errors             | surrogateescape     |
| xontrib                     | []                  |
| RC file                     | []                  |
| UPDATE_OS_ENVIRON           | False               |
| XONSH_CAPTURE_ALWAYS        | False               |
| XONSH_SUBPROC_OUTPUT_FORMAT | stream_lines        |
| THREAD_SUBPROCS             | True                |
| XONSH_CACHE_SCRIPTS         | True                |
+-----------------------------+---------------------+
gil@stravaig ~ @ def _f():
................     1 / 0
gil@stravaig ~ @ aliases['f'] = _f
gil@stravaig ~ @ f
xonsh: For full traceback set: $XONSH_SHOW_TRACEBACK = True
Exception in thread {'cls': 'ProcProxyThread', 'name': 'Thread-15', 'func': '_f', 'alias': 'f', 'pid': None}
ZeroDivisionError: division by zero
gil@stravaig ~ [1] @ $XONSH_SHOW_TRACEBACK = True
gil@stravaig ~ @ f
Exception in thread {'cls': 'ProcProxyThread', 'name': 'Thread-22', 'func': '_f', 'alias': 'f', 'pid': None}
xonsh: To log full traceback to a file set: $XONSH_TRACEBACK_LOGFILE = <filename>
Traceback (most recent call last):
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/procs/proxies.py", line 540, in run
    r = self.f(self.args, sp_stdin, sp_stdout, sp_stderr, spec, spec.stack)
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/procs/proxies.py", line 290, in proxy_zero
    return f()
  File "<stdin>", line 2, in _f
ZeroDivisionError: division by zero

gil@stravaig ~ [1] @ f
Exception in thread {'cls': 'ProcProxyThread', 'name': 'Thread-27', 'func': '_f', 'alias': 'f', 'pid': None}
xonsh: To log full traceback to a file set: $XONSH_TRACEBACK_LOGFILE = <filename>
Traceback (most recent call last):
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/procs/proxies.py", line 540, in run
    r = self.f(self.args, sp_stdin, sp_stdout, sp_stderr, spec, spec.stack)
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/procs/proxies.py", line 290, in proxy_zero
    return f()
  File "<stdin>", line 2, in _f
ZeroDivisionError: division by zero

This is on this PR branch:

gil@stravaig ~ @ xonfig
+-----------------------------+---------------------+
| xonsh                       | 0.16.0.dev134       |
| Git SHA                     | 1b5c30b9            |
| Commit Date                 | May 7 18:45:11 2024 |
| Python                      | 3.10.12             |
| PLY                         | 3.11                |
| have readline               | True                |
| prompt toolkit              | 3.0.39              |
| shell type                  | prompt_toolkit      |
| history backend             | json                |
| pygments                    | 2.16.1              |
| on posix                    | True                |
| on linux                    | True                |
| distro                      | ubuntu              |
| on wsl                      | False               |
| on darwin                   | False               |
| on windows                  | False               |
| on cygwin                   | False               |
| on msys2                    | False               |
| is superuser                | False               |
| default encoding            | utf-8               |
| xonsh encoding              | utf-8               |
| encoding errors             | surrogateescape     |
| xontrib                     | []                  |
| RC file                     | []                  |
| UPDATE_OS_ENVIRON           | False               |
| XONSH_CAPTURE_ALWAYS        | False               |
| XONSH_SUBPROC_OUTPUT_FORMAT | stream_lines        |
| THREAD_SUBPROCS             | True                |
| XONSH_CACHE_SCRIPTS         | True                |
+-----------------------------+---------------------+
gil@stravaig ~ @ def _f():
................     1 / 0
................
gil@stravaig ~ @ aliases['f'] = _f
gil@stravaig ~ @ f
xonsh: For full traceback set: $XONSH_SHOW_TRACEBACK = True
ZeroDivisionError: division by zero
Exception in FuncAlias({'name': 'f', 'func': <function _f at 0x77d7466c3370>})
gil@stravaig ~ @ $XONSH_SHOW_TRACEBACK = True
gil@stravaig ~ @ f
gil@stravaig ~ @ f
xonsh: To log full traceback to a file set: $XONSH_TRACEBACK_LOGFILE = <filename>
Traceback (most recent call last):
  File "/home/gil/mambaforge/lib/python3.10/site-packages/xonsh/aliases.py", line 87, in __call__
    return self.func(*func_args)
  File "<stdin>", line 2, in _f
ZeroDivisionError: division by zero
Exception in FuncAlias({'name': 'f', 'func': <function _f at 0x77d7466c3370>})

for more information, see https://pre-commit.ci

anki-code · 2024-05-11T10:30:35Z

@gforsyth hey!

I traced the issue you faced with and made notes in feat: make stack trace behave like in python #4662 (comment) and created task print_exception: rewrite deprecated code #5405
I changed the code in this PR to have soft workaround of this issue. I noticed that I already show the alias name and additional print_exception is not needed.
I added full integration test coverage for printing messages.
It's ready to review.

Thanks!

gforsyth

Nice work on this, @anki-code !

a and others added 2 commits April 25, 2024 18:53

FuncAlias

5fb6485

[pre-commit.ci] auto fixes from pre-commit.com hooks

2dcc6f9

for more information, see https://pre-commit.ci

anki-code requested review from gforsyth and jnoortheen April 25, 2024 17:04

FuncAlias

12322eb

jnoortheen reviewed Apr 26, 2024

View reviewed changes

xonsh/aliases.py Outdated Show resolved Hide resolved

anki-code requested a review from jnoortheen April 26, 2024 08:42

a and others added 13 commits April 27, 2024 16:59

Merge remote-tracking branch 'origin/main' into func_alias

6c9ceca

wip

d7a4af7

[pre-commit.ci] auto fixes from pre-commit.com hooks

0ddbca0

for more information, see https://pre-commit.ci

wip

8f58a2f

update

6893614

wip

daf7f18

[pre-commit.ci] auto fixes from pre-commit.com hooks

49732d3

for more information, see https://pre-commit.ci

wip

87b59f9

update

a95de7f

[pre-commit.ci] auto fixes from pre-commit.com hooks

226ef6f

for more information, see https://pre-commit.ci

Merge remote-tracking branch 'origin/main' into func_alias

ee3dad5

inherit __doc__

bf12f62

[pre-commit.ci] auto fixes from pre-commit.com hooks

330fa12

for more information, see https://pre-commit.ci

anki-code added the aliases label May 1, 2024

Merge remote-tracking branch 'origin/main' into func_alias

ea5014d

a added 2 commits May 3, 2024 01:49

Merge remote-tracking branch 'origin/main' into func_alias

d13b5a8

Merge remote-tracking branch 'origin/main' into func_alias

898d24a

a added 2 commits May 8, 2024 00:45

news

8b5b76a

Merge remote-tracking branch 'origin/func_alias' into func_alias

1b5c30b

anki-code requested a review from gforsyth May 7, 2024 22:51

gforsyth requested changes May 8, 2024

View reviewed changes

anki-code marked this pull request as draft May 8, 2024 15:43

Merge remote-tracking branch 'origin/main' into func_alias

09e7d36

anki-code mentioned this pull request May 11, 2024

feat: make stack trace behave like in python #4662

Merged

a and others added 10 commits May 11, 2024 11:38

wip

235917c

wip

c3d84e9

[pre-commit.ci] auto fixes from pre-commit.com hooks

f00c121

for more information, see https://pre-commit.ci

wip

5790d54

Fix tests

a1726c7

Merge remote-tracking branch 'origin/func_alias' into func_alias

00a2ccc

[pre-commit.ci] auto fixes from pre-commit.com hooks

c7dc5c0

for more information, see https://pre-commit.ci

Fix tests

73afcbe

Merge remote-tracking branch 'origin/func_alias' into func_alias

847317f

[pre-commit.ci] auto fixes from pre-commit.com hooks

7a26c12

for more information, see https://pre-commit.ci

anki-code marked this pull request as ready for review May 11, 2024 10:19

anki-code requested a review from gforsyth May 11, 2024 10:19

anki-code mentioned this pull request May 12, 2024

print_exception and threaded alias: no traceback on second run #5408

Open

gforsyth approved these changes May 13, 2024

View reviewed changes

gforsyth merged commit bb394a8 into main May 13, 2024
15 checks passed

gforsyth deleted the func_alias branch May 13, 2024 13:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added FuncAlias #5366

Added FuncAlias #5366

anki-code commented Apr 25, 2024 •

edited

anki-code commented May 2, 2024

jnoortheen commented May 2, 2024

anki-code commented May 2, 2024

jnoortheen commented May 2, 2024

anki-code commented May 2, 2024 •

edited

jnoortheen commented May 2, 2024

anki-code commented May 7, 2024 •

edited

gforsyth commented May 7, 2024

anki-code commented May 7, 2024

gforsyth commented May 8, 2024 •

edited by anki-code

gforsyth left a comment

anki-code commented May 8, 2024 •

edited

gforsyth commented May 8, 2024 •

edited by anki-code

anki-code commented May 11, 2024

gforsyth left a comment

Added FuncAlias #5366

Added FuncAlias #5366

Conversation

anki-code commented Apr 25, 2024 • edited

Goals

Exception

Before

After

Superhelp

Before

After

For community

anki-code commented May 2, 2024

jnoortheen commented May 2, 2024

anki-code commented May 2, 2024

jnoortheen commented May 2, 2024

anki-code commented May 2, 2024 • edited

jnoortheen commented May 2, 2024

anki-code commented May 7, 2024 • edited

gforsyth commented May 7, 2024

anki-code commented May 7, 2024

gforsyth commented May 8, 2024 • edited by anki-code

gforsyth left a comment

Choose a reason for hiding this comment

anki-code commented May 8, 2024 • edited

gforsyth commented May 8, 2024 • edited by anki-code

anki-code commented May 11, 2024

gforsyth left a comment

Choose a reason for hiding this comment

anki-code commented Apr 25, 2024 •

edited

anki-code commented May 2, 2024 •

edited

anki-code commented May 7, 2024 •

edited

gforsyth commented May 8, 2024 •

edited by anki-code

anki-code commented May 8, 2024 •

edited

gforsyth commented May 8, 2024 •

edited by anki-code