Mercurial > hg > pyloader
annotate README.txt @ 39:db095765807d
update decorator syntax
| author | Jeff Hammel <jhammel@mozilla.com> |
|---|---|
| date | Tue, 07 Jun 2011 22:08:57 -0700 |
| parents | ff634cc2e62b |
| children | 0b2019d0af98 |
| rev | line source |
|---|---|
| 0 | 1 pyloader |
| 2 =========== | |
| 3 | |
|
7
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
4 Load python attributes from strings |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
5 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
6 JSON Format |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
7 ----------- |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
8 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
9 pyloader uses a JSON-serializable format for the canonical |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
10 (serializable) form of python objects:: |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
11 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
12 {'foo': # (arbitrary) object name, |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
13 {'args': ['positional', 'arguments'], |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
14 'kwargs': {'keyword': 'arguments}, |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
15 'path': 'dotted.or.file.path:ObjectName'}, |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
16 'bar': ... } # etc |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
17 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
18 Objects are instantiated like:: |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
19 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
20 ObjectName(*args, **kwargs) |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
21 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
22 In the case that the object is not to be instantiated (e.g. a |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
23 standalone function, ``args`` and ``kwargs`` will either not be |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
24 present or will be None (``null`` in JSON). |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
25 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
26 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
27 INI Format |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
28 ---------- |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
29 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
30 pyloader also features an INI format which is translated to the JSON |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
31 Format but adds a few convenience features. A simple object is |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
32 expressed as:: |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
33 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
34 [foo:dotted.or.file.path:ObjectName] |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
35 . = positional, arguments |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
36 keyword = arguments |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
37 |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
38 ``.`` expresses positional arguments which is a comma-separated |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
39 list. The remaining (key, value) pairs become keyword arguments. The |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
40 section name contains the object name (e.g. ``foo``) followed by a |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
41 ``:`` followed by a loading path. Like JSON, a dotted path or a file |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
42 path may be used. In addition, other (pluggable) loading paths are |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
43 available: |
|
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
44 |
| 8 | 45 - override loader: you can use a section name like ``[foo:bar]`` to |
| 46 override variables from the ``bar`` object with variables from | |
| 47 ``foo``:: | |
| 48 | |
| 49 [foo:bar] | |
| 50 . = cats, dogs | |
| 51 type = count | |
| 52 | |
| 53 [bar:%(here)s/some/path.py:MyObject] | |
| 54 . = elephants | |
| 55 type = concatenate | |
| 56 | |
| 57 The above results in a JSON blob for foo like:: | |
| 58 | |
| 59 {'foo': {'args': ['elephants', 'cats', 'dogs'], | |
| 60 'kwargs': {'type': 'concatenate'}, | |
| 61 'path': '/location/of/ini/file/some/path.py:MyObject'}} | |
| 62 | |
| 63 ``args`` is extended. ``kwargs`` will be overridden. | |
| 64 | |
|
9
ff634cc2e62b
unfinished sketch of an abstract factory
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
65 - wrappers: in addition to the override pattern, you can also wrap an |
|
ff634cc2e62b
unfinished sketch of an abstract factory
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
66 object:: |
|
ff634cc2e62b
unfinished sketch of an abstract factory
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
67 |
|
ff634cc2e62b
unfinished sketch of an abstract factory
Jeff Hammel <jhammel@mozilla.com>
parents:
8
diff
changeset
|
68 [foo:bar:baz] |
|
7
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
69 |
| 39 | 70 This will create an object, ``foo`` which wraps the object ``baz`` in |
| 71 by the pattern given by ``bar``. In this case, ``bar`` is provided | |
| 72 a special variable, `%(app)s`. | |
| 73 | |
| 74 You can also do:: | |
| 75 | |
| 76 [foo:bar:hi,hello,x=1,y=2:%(here)/objects.py:MyClass] | |
| 77 | |
| 78 | |
|
7
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
79 In addition, .ini files may include other .ini files. This allows for |
| 8 | 80 encapsulation of intent of specific .ini files:: |
| 81 | |
| 82 [include:%(here)s/some/file.ini] | |
|
7
79676a48f6d8
begin porting and modernizing instructions from wsgiblob to pyloader
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
83 |
| 8 | 84 INI files have a few convenience variables: |
| 85 | |
| 86 - %(here)s : the location of the directory the .ini file lives in | |
| 87 - %(app)s : used for wrappers | |
| 88 | |
| 89 Additional variables may be provided by the consumer. | |
| 0 | 90 |
| 91 ---- | |
| 92 | |
| 93 Jeff Hammel | |
| 94 http://k0s.org/ | |
| 95 |