Scriptvorlage für Python-Scripts

Die Begründung, warum ich eine Vorlage mache, findet sich an einer anderen Stelle. Normal verwende ich eher Perl als Scriptsprache. Trotzdem findet sich hier auch eine kleine Vorlage für Python-Scripte.

Dieses grundlegende Script sollte theoretisch mit Python 2 oder mit Python 3 funktionieren. Ich verwende jedoch tendenziell eher Python 3 und teste das Script daher auch hauptsächlich damit.

Beschreibung

Wie auch bei den anderen Scriptvorlagen kann dieses Script vor allem Parameter einlesen. Es unterstützt sowohl Kurz- als auch Langform von Parametern. Die Dokumentation kann mit --help ausgegeben werden. Diese sieht zum Beispiel folgendermaßen aus:

usage: template.py [-h] [-l {DEBUG,INFO,WARNING,ERROR,CRITICAL}] -n NUMBER
                   text [text ...]

Template for Python Scripts. Can be used as a basis for simple scripts.

positional arguments:
  text                  Text arguments. One or more can be appended to the
                        call.

optional arguments:
  -h, --help            show this help message and exit
  -l {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}
                        Define log level.
  -n NUMBER, --number NUMBER
                        A number

Bei dem Beispiel muss eine Nummer mittels des Parameters --number angegeben werden. Des weiteren muss mindestens ein weiteres Textargument angegeben werden. Die Parameter werden alle von argparse verarbeitet. Ein Aufruf kann folgendermaßen aussehen:

sh> ./template.py -l info eins zwei -n 54
INFO:__main__:Started with the following options: Namespace(loglevel='INFO', number=54.0, text=['eins', 'zwei'])
Text arguments: ['eins', 'zwei']
sh>

Die Texte eins und zwei dürfen dabei nicht von anderen Argumenten unterbrochen werden.

Vorlage

Das Beispielscript kann hier heruntergeladen werden. Das Script wendet eigentlich nur das argparse Modul von Python an. Die Dokumentation dazu findet sich direkt auf der Python Homepage.

Normal verwende ich tendenziell eher Tabs zur Einrückung bei meinem Quellcode. Bei Python sind jedoch laut dem Python Style Guide (zu finden unter der Bezeichnung PEP 8 Leerzeichen vorzuziehen.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# Copyright (c) 2014 Christian Mauderer <oss@c-mauderer.de>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

import logging
import argparse
import sys

parser = argparse.ArgumentParser(
    description=(
        "Template for Python Scripts.\n"
        "Can be used as a basis for simple scripts.\n"
    ))

parser.add_argument(
    "text",
    help="Text arguments. One or more can be appended to the call.",
    nargs='+'
)
parser.add_argument(
    "-l", "--loglevel",
    help = "Define log level.",
    type = str.upper,
    choices = ['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
    default = 'warning'
)
parser.add_argument(
    "-n", "--number",
    help="A number",
    type=float,
    required=True
)

args = parser.parse_args()

# set up logging
numeric_loglevel = getattr(logging, args.loglevel)
logging.basicConfig(level = numeric_loglevel)
logger = logging.getLogger(__name__)
logger.info("Started with the following options: {}".format(str(args)))

print('Text arguments:', args.text)

# vim: set ts=4 sw=4 et: