Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Minor refactor of exception to top of module

Browse source
This commit is contained in:
Griatch 2021-04-08 20:44:53 +02:00
parent 2ded469357
commit f9a2f9f095
2 changed files with 15 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/source/Components/FuncParser.md
View file

@ -1,5 +1,9 @@
# The Inline Function Parser # The Inline Function Parser
```
```
The [FuncParser](api:evennia.utils.funcparser#evennia.utils.funcparser.FuncParser) extracts and executes The [FuncParser](api:evennia.utils.funcparser#evennia.utils.funcparser.FuncParser) extracts and executes
'inline functions' 'inline functions'
embedded in a string on the form `$funcname(args, kwargs)`. Under the hood, this will embedded in a string on the form `$funcname(args, kwargs)`. Under the hood, this will
@ -65,7 +69,7 @@ The FuncParser can be applied to any string. Out of the box it's applied in a fe
## Using the FuncParser ## Using the FuncParser
You can apply inline function parsing to any string. The You can apply inline function parsing to any string. The
[FuncParser](api:evennia.utils.funcparser.FuncParser) is found in `evennia.utils.funcparser.py`. [FuncParser](api:evennia.utils.funcparser.FuncParser) is imported as `evennia.utils.funcparser`.
```python ```python
from evennia.utils import funcparser from evennia.utils import funcparser
@ -85,7 +89,7 @@ available to the parser as you parse strings with it. It can either be
to include and how they should be named. Do you want a callable to be available under more than one name? to include and how they should be named. Do you want a callable to be available under more than one name?
Just add it multiple times to the dict, with a different key. Just add it multiple times to the dict, with a different key.
- A `module` or (more commonly) a `python-path` to a module. This module can define a dict - A `module` or (more commonly) a `python-path` to a module. This module can define a dict
`FUNCPARSER_CALLABLES = {"funcname": callable, ...}` - this will be imported and used like ther `dict` above. `FUNCPARSER_CALLABLES = {"funcname": callable, ...}` - this will be imported and used like the `dict` above.
If no such variable is defined, _every_ top-level function in the module (whose name doesn't start with If no such variable is defined, _every_ top-level function in the module (whose name doesn't start with
an underscore `_`) will be considered a suitable callable. The name of the function will be the `$funcname` an underscore `_`) will be considered a suitable callable. The name of the function will be the `$funcname`
by which it can be called. by which it can be called.
@ -123,7 +127,7 @@ Here the callable will be called as
```python ```python
_test('foo', bar='4', mydefault=2, myreserved=[1, 2, 3], _test('foo', bar='4', mydefault=2, myreserved=[1, 2, 3],
funcparser=<FuncParser>, raise_errrors=False) funcparser=<FuncParser>, raise_errors=False)
``` ```
The `mydefault=2` kwarg could be overwritten if we made the call as `$test(mydefault=...)` The `mydefault=2` kwarg could be overwritten if we made the call as `$test(mydefault=...)`

14
evennia/commands/command.py
View file

@ -16,6 +16,13 @@ from evennia.utils.evtable import EvTable
from evennia.utils.ansi import ANSIString from evennia.utils.ansi import ANSIString
class InterruptCommand(Exception):
"""Cleanly interrupt a command."""
pass
def _init_command(cls, **kwargs): def _init_command(cls, **kwargs):
""" """
Helper command. Helper command.
@ -666,10 +673,3 @@ Command {self} has no defined `func()` - showing on-command variables:
if "mode" not in kwargs: if "mode" not in kwargs:
kwargs["mode"] = "footer" kwargs["mode"] = "footer"
return self._render_decoration(*args, **kwargs) return self._render_decoration(*args, **kwargs)
class InterruptCommand(Exception):
"""Cleanly interrupt a command."""
pass