Use collections.defaultdict instead of homebrew version. Fix tests.
[pylit.git] / doc / filename-extensions.txt
blob4617e290ef5a2aa594f303778d51e15efed00375
1 .. -*- rst-mode -*-
3 Finding a Filename Extension for Literate Sources
4 *************************************************
6 Finding an easy to remember, unused file name extension is not easy.
8 .py.txt
9   a double extension (similar to .tar.gz, say) seems most appropriate (at
10   least on UNIX). The same scheme can be used for c.txt, p.txt and the like.
11   However, it fails on FAT16 file systems.
13 .pytxt
14   is recognised as extension by os.path.splitext but also fails on FAT16
16 .pyt 
17   (PYthon Text) is used by the Python test interpreter
18   `pytest <http//:www.zetadev.com/software/pytest/>`__
20 .pyl
21   was once mentioned as extension for "literate Python" files in an email
22   exchange but subsequently used for Python libraries.
24 .lpy 
25   seems to be free (as by a Google search, "lpy" is the name of a python
26   code pretty printer but this should not pose a problem).
28 .tpy
29   seems to be free as well.
31 All these extensions are Python specific. A new search for nice and unused
32 extensions would have to be repeated for every language supported by PyLit.
34 After considering the alternatives, the additional extension ``.txt`` was
35 chosen for the text source (for Python this becomes ``py.txt``).