home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pyth_os2.zip / python-1.0.2 / Lib / pipes.py < prev    next >
Text File  |  1993-12-29  |  9KB  |  302 lines

  1. # Conversion pipeline templates
  2. # =============================
  3.  
  4.  
  5. # The problem:
  6. # ------------
  7. # Suppose you have some data that you want to convert to another format
  8. # (e.g. from GIF image format to PPM image format).  Maybe the
  9. # conversion involves several steps (e.g. piping it through compress or
  10. # uuencode).  Some of the conversion steps may require that their input
  11. # is a disk file, others may be able to read standard input; similar for
  12. # their output.  The input to the entire conversion may also be read
  13. # from a disk file or from an open file, and similar for its output.
  14. # The module lets you construct a pipeline template by sticking one or
  15. # more conversion steps together.  It will take care of creating and
  16. # removing temporary files if they are necessary to hold intermediate
  17. # data.  You can then use the template to do conversions from many
  18. # different sources to many different destinations.  The temporary
  19. # file names used are different each time the template is used.
  20. #
  21. # The templates are objects so you can create templates for many
  22. # different conversion steps and store them in a dictionary, for
  23. # instance.
  24.  
  25.  
  26. # Directions:
  27. # -----------
  28. #
  29. # To create a template:
  30. #   t = Template()
  31. #
  32. # To add a conversion step to a template:
  33. #   t.append(command, kind)
  34. # where kind is a string of two characters: the first is '-' if the
  35. # command reads its standard input or 'f' if it requires a file; the
  36. # second likewise for the output. The command must be valid /bin/sh
  37. # syntax.  If input or output files are required, they are passed as
  38. # $IN and $OUT; otherwise, it must be  possible to use the command in
  39. # a pipeline.
  40. #
  41. # To add a conversion step at the beginning:
  42. #   t.prepend(command, kind)
  43. #
  44. # To convert a file to another file using a template:
  45. #   sts = t.copy(infile, outfile)
  46. # If infile or outfile are the empty string, standard input is read or
  47. # standard output is written, respectively.  The return value is the
  48. # exit status of the conversion pipeline.
  49. # To open a file for reading or writing through a conversion pipeline:
  50. #   fp = t.open(file, mode)
  51. # where mode is 'r' to read the file, or 'w' to write it -- just like
  52. # for the built-in function open() or for os.popen().
  53. #
  54. # To create a new template object initialized to a given one:
  55. #   t2 = t.clone()
  56. #
  57. # For an example, see the function test() at the end of the file.
  58.  
  59.  
  60. import sys
  61. import regex
  62.  
  63. import os
  64. import tempfile
  65. import string
  66.  
  67.  
  68. # Conversion step kinds
  69.  
  70. FILEIN_FILEOUT = 'ff'            # Must read & write real files
  71. STDIN_FILEOUT  = '-f'            # Must write a real file
  72. FILEIN_STDOUT  = 'f-'            # Must read a real file
  73. STDIN_STDOUT   = '--'            # Normal pipeline element
  74. SOURCE         = '.-'            # Must be first, writes stdout
  75. SINK           = '-.'            # Must be last, reads stdin
  76.  
  77. stepkinds = [FILEIN_FILEOUT, STDIN_FILEOUT, FILEIN_STDOUT, STDIN_STDOUT, \
  78.          SOURCE, SINK]
  79.  
  80.  
  81. # A pipeline template is a Template object:
  82.  
  83. class Template:
  84.  
  85.     # Template() returns a fresh pipeline template
  86.     def __init__(self):
  87.         self.debugging = 0
  88.         self.reset()
  89.  
  90.     # t.__repr__() implements `t`
  91.     def __repr__(self):
  92.         return '<Template instance, steps=' + `self.steps` + '>'
  93.  
  94.     # t.reset() restores a pipeline template to its initial state
  95.     def reset(self):
  96.         self.steps = []
  97.  
  98.     # t.clone() returns a new pipeline template with identical
  99.     # initial state as the current one
  100.     def clone(self):
  101.         t = Template()
  102.         t.steps = self.steps[:]
  103.         t.debugging = self.debugging
  104.         return t
  105.  
  106.     # t.debug(flag) turns debugging on or off
  107.     def debug(self, flag):
  108.         self.debugging = flag
  109.  
  110.     # t.append(cmd, kind) adds a new step at the end
  111.     def append(self, cmd, kind):
  112.         if type(cmd) <> type(''):
  113.             raise TypeError, \
  114.                   'Template.append: cmd must be a string'
  115.         if kind not in stepkinds:
  116.             raise ValueError, \
  117.                   'Template.append: bad kind ' + `kind`
  118.         if kind == SOURCE:
  119.             raise ValueError, \
  120.                   'Template.append: SOURCE can only be prepended'
  121.         if self.steps <> [] and self.steps[-1][1] == SINK:
  122.             raise ValueError, \
  123.                   'Template.append: already ends with SINK'
  124.         if kind[0] == 'f' and regex.search('\$IN', cmd) < 0:
  125.             raise ValueError, \
  126.                   'Template.append: missing $IN in cmd'
  127.         if kind[1] == 'f' and regex.search('\$OUT', cmd) < 0:
  128.             raise ValueError, \
  129.                   'Template.append: missing $OUT in cmd'
  130.         self.steps.append((cmd, kind))
  131.  
  132.     # t.prepend(cmd, kind) adds a new step at the front
  133.     def prepend(self, cmd, kind):
  134.         if type(cmd) <> type(''):
  135.             raise TypeError, \
  136.                   'Template.prepend: cmd must be a string'
  137.         if kind not in stepkinds:
  138.             raise ValueError, \
  139.                   'Template.prepend: bad kind ' + `kind`
  140.         if kind == SINK:
  141.             raise ValueError, \
  142.                   'Template.prepend: SINK can only be appended'
  143.         if self.steps <> [] and self.steps[0][1] == SOURCE:
  144.             raise ValueError, \
  145.                   'Template.prepend: already begins with SOURCE'
  146.         if kind[0] == 'f' and regex.search('\$IN\>', cmd) < 0:
  147.             raise ValueError, \
  148.                   'Template.prepend: missing $IN in cmd'
  149.         if kind[1] == 'f' and regex.search('\$OUT\>', cmd) < 0:
  150.             raise ValueError, \
  151.                   'Template.prepend: missing $OUT in cmd'
  152.         self.steps.insert(0, (cmd, kind))
  153.  
  154.     # t.open(file, rw) returns a pipe or file object open for
  155.     # reading or writing; the file is the other end of the pipeline
  156.     def open(self, file, rw):
  157.         if rw == 'r':
  158.             return self.open_r(file)
  159.         if rw == 'w':
  160.             return self.open_w(file)
  161.         raise ValueError, \
  162.               'Template.open: rw must be \'r\' or \'w\', not ' + `rw`
  163.  
  164.     # t.open_r(file) and t.open_w(file) implement
  165.     # t.open(file, 'r') and t.open(file, 'w') respectively
  166.  
  167.     def open_r(self, file):
  168.         if self.steps == []:
  169.             return open(file, 'r')
  170.         if self.steps[-1][1] == SINK:
  171.             raise ValueError, \
  172.                   'Template.open_r: pipeline ends width SINK'
  173.         cmd = self.makepipeline(file, '')
  174.         return os.popen(cmd, 'r')
  175.  
  176.     def open_w(self, file):
  177.         if self.steps == []:
  178.             return open(file, 'w')
  179.         if self.steps[0][1] == SOURCE:
  180.             raise ValueError, \
  181.                   'Template.open_w: pipeline begins with SOURCE'
  182.         cmd = self.makepipeline('', file)
  183.         return os.popen(cmd, 'w')
  184.  
  185.     def copy(self, infile, outfile):
  186.         return os.system(self.makepipeline(infile, outfile))
  187.  
  188.     def makepipeline(self, infile, outfile):
  189.         cmd = makepipeline(infile, self.steps, outfile)
  190.         if self.debugging:
  191.             print cmd
  192.             cmd = 'set -x; ' + cmd
  193.         return cmd
  194.  
  195.  
  196. def makepipeline(infile, steps, outfile):
  197.     # Build a list with for each command:
  198.     # [input filename or '', command string, kind, output filename or '']
  199.     
  200.     list = []
  201.     for cmd, kind in steps:
  202.         list.append(['', cmd, kind, ''])
  203.     #
  204.     # Make sure there is at least one step
  205.     #
  206.     if list == []:
  207.         list.append(['', 'cat', '--', ''])
  208.     #
  209.     # Take care of the input and output ends
  210.     #
  211.     [cmd, kind] = list[0][1:3]
  212.     if kind[0] == 'f' and not infile:
  213.         list.insert(0, ['', 'cat', '--', ''])
  214.     list[0][0] = infile
  215.     #
  216.     [cmd, kind] = list[-1][1:3]
  217.     if kind[1] == 'f' and not outfile:
  218.         list.append(['', 'cat', '--', ''])
  219.     list[-1][-1] = outfile
  220.     #
  221.     # Invent temporary files to connect stages that need files
  222.     #
  223.     garbage = []
  224.     for i in range(1, len(list)):
  225.         lkind = list[i-1][2]
  226.         rkind = list[i][2]
  227.         if lkind[1] == 'f' or rkind[0] == 'f':
  228.             temp = tempfile.mktemp()
  229.             garbage.append(temp)
  230.             list[i-1][-1] = list[i][0] = temp
  231.     #
  232.     for item in list:
  233.         [inf, cmd, kind, outf] = item
  234.         if kind[1] == 'f':
  235.             cmd = 'OUT=' + quote(outf) + '; ' + cmd
  236.         if kind[0] == 'f':
  237.             cmd = 'IN=' + quote(inf) + '; ' + cmd
  238.         if kind[0] == '-' and inf:
  239.             cmd = cmd + ' <' + quote(inf)
  240.         if kind[1] == '-' and outf:
  241.             cmd = cmd + ' >' + quote(outf)
  242.         item[1] = cmd
  243.     #
  244.     cmdlist = list[0][1]
  245.     for item in list[1:]:
  246.         [cmd, kind] = item[1:3]
  247.         if item[0] == '':
  248.             if 'f' in kind:
  249.                 cmd = '{ ' + cmd + '; }'
  250.             cmdlist = cmdlist + ' |\n' + cmd
  251.         else:
  252.             cmdlist = cmdlist + '\n' + cmd
  253.     #
  254.     if garbage:
  255.         rmcmd = 'rm -f'
  256.         for file in garbage:
  257.             rmcmd = rmcmd + ' ' + quote(file)
  258.         trapcmd = 'trap ' + quote(rmcmd + '; exit') + ' 1 2 3 13 14 15'
  259.         cmdlist = trapcmd + '\n' + cmdlist + '\n' + rmcmd
  260.     #
  261.     return cmdlist
  262.  
  263.  
  264. # Reliably quote a string as a single argument for /bin/sh
  265.  
  266. _safechars = string.letters + string.digits + '!@%_-+=:,./'    # Safe unquoted
  267. _funnychars = '"`$\\'                # Unsafe inside "double quotes"
  268.  
  269. def quote(file):
  270.     for c in file:
  271.         if c not in _safechars:
  272.             break
  273.     else:
  274.         return file
  275.     if '\'' not in file:
  276.         return '\'' + file + '\''
  277.     res = ''
  278.     for c in file:
  279.         if c in _funnychars:
  280.             c = '\\' + c
  281.         res = res + c
  282.     return '"' + res + '"'
  283.  
  284.  
  285. # Small test program and example
  286.  
  287. def test():
  288.     import os
  289.     print 'Testing...'
  290.     t = Template()
  291.     t.append('togif $IN $OUT', 'ff')
  292.     t.append('giftoppm', '--')
  293.     t.append('ppmtogif >$OUT', '-f')
  294.     t.append('fromgif $IN $OUT', 'ff')
  295.     t.debug(1)
  296.     FILE = '/usr/local/images/rgb/rogues/guido.rgb'
  297.     t.copy(FILE, '@temp')
  298.     print 'Done.'
  299.