diff options
| author | Michele Simionato <michele.simionato@gmail.com> | 2018-04-15 14:44:35 +0200 |
|---|---|---|
| committer | Michele Simionato <michele.simionato@gmail.com> | 2018-04-15 14:44:35 +0200 |
| commit | 6c7d67b033a17eaaa551adbc9cdc9ad098a2bc59 (patch) | |
| tree | 4a96dc2f632346fbe554cf92e5f76374e78f8ad3 /src | |
| parent | 9e5235962d8d7e67f41a1ef7b7d70b1cc7e55d0b (diff) | |
| download | python-decorator-git-6c7d67b033a17eaaa551adbc9cdc9ad098a2bc59.tar.gz | |
Updated docs [skip CI]
Diffstat (limited to 'src')
| -rw-r--r-- | src/tests/documentation.py | 24 |
1 files changed, 19 insertions, 5 deletions
diff --git a/src/tests/documentation.py b/src/tests/documentation.py index 0d8ebf5..2da44c6 100644 --- a/src/tests/documentation.py +++ b/src/tests/documentation.py @@ -433,11 +433,25 @@ available. For instance: some data Decorator factories are most useful to framework builders. Here is an example -that gives an idea of how you could manage permissions in a Web framework: +that gives an idea of how you could manage permissions in a framework: -$$restricted $$Action +where `restricted` is a decorator factory defined as follows + +$$restricted + +In general a decorator factory has a signature + +.. code-block:: python + + def decfactory(func, param1=default1, .., paramN=defaultN, *args, **kw): + ... + +Each parameter must have a default, so that `decfactory` can work +as an alias for `decfactory()`, i.e. the decorator in which are parameters +have the default value. + ``decorator(cls)`` -------------------------------------------- @@ -1528,15 +1542,15 @@ def restricted(func, user_class=User, *args, **kw): class Action(object): @restricted(User) def view(self): - pass + "Any user can view objects" @restricted(PowerUser) def insert(self): - pass + "Only power users can insert objects" @restricted(Admin) def delete(self): - pass + "Only the admin can delete objects" class TailRecursive(object): |
