How do I make python programs behave like proper unix tools?

Question

I have a few Python scripts laying around, and I'm working on rewriting them. I have the same problem with all of them.

It's not obvious to me how to write the programs so that they behave like proper unix tools.

Because this

$ cat characters | progname

and this

$ progname characters

should produce the same output.

The closest thing I could find to that in Python was the fileinput library. Unfortunately, I don't really see how to rewrite my Python scripts, all of which look like this:

#!/usr/bin/env python 
# coding=UTF-8

import sys, re

for file in sys.argv[1:]:
    f = open(file)
    fs = f.read()
    regexnl = re.compile('[^\s\w.,?!:;-]')
    rstuff = regexnl.sub('', fs)
    f.close()
    print rstuff

The fileinput library processes stdin if there is a stdin, and processes a file if there is a file. But it iterates over single lines.

import fileinput
for line in fileinput.input():
    process(line)

I really don't get that. I guess if you're dealing with small files, or if you're not doing much to the files, this may seem obvious. But, for my purposes, this makes it much slower than simply opening the entire file and reading it into a string, as above.

Currently I run the script above like

$ pythonscript textfilename1 > textfilename2

But I want to be able to run it (and its brethren) in pipes, like

$ grep pattern textfile1 | pythonscript | pythonscript | pythonscript > textfile2

Answer 1

Check if a filename is given as an argument, or else read from sys.stdin.

Something like this:

if len(sys.argv) > 0:
   f = open(sys.argv[1])
else:
   f = sys.stdin 

It's similar to Mikel's answer except it uses the sys module. I figure if they have it in there it must be for a reason...

Answer 2

Why not just

files = sys.argv[1:]
if not files:
    files = ["/dev/stdin"]

for file in files:
    f = open(file)
    ...

Answer 3

My preferred way of doing it turns out to be... (and this is taken from a nice little Linux blog called Harbinger's Hollow)

#!/usr/bin/env python

import argparse, sys

parser = argparse.ArgumentParser()
parser.add_argument('filename', nargs='?')
args = parser.parse_args()
if args.filename:
    string = open(args.filename).read()
elif not sys.stdin.isatty():
    string = sys.stdin.read()
else:
    parser.print_help()

The reason why I liked this best is that, as the blogger says, it just outputs a silly message if accidentally called without input. It also slots so nicely into all of my existing Python scripts that I have modified them all to include it.

Answer 4

files=sys.argv[1:]

for f in files or [sys.stdin]:
   if isinstance(f, file):
      txt = f.read()
   else:
      txt = open(f).read()

   process(txt)

Answer 5

I am using this solution and it works like a charm. Actually I am using in a script calle unaccent that lowercases and removes accents from a given string

argument = sys.argv[1:] if len(sys.argv) > 1 else sys.stdin.read()

I guess the firest time I saw this solution was here.

Answer 6

If your system doesn't have /dev/stdin, or you want a more general solution, you could try something more complicated like:

class Stdin(object):
    def __getattr__(self, attr):
        return getattr(sys.stdin, attr)

    def __enter__(self):
        return self

def myopen(path):
    if path == "-":
        return Stdin()
    return open(path)

for n in sys.argv[1:] or ["-"]:
    with myopen(n) as f:
            ...