Scripts

1.1   Hashbang

Alle scripts starter med hashbang. Følgende kommentar skal benyttes:

#!/usr/bin/env python

Ved å bruke /usr/bin/env vil vi ha mulighet for å overstyre dette i miljøet Cerebrum kjører i, samt at installasjon med setup.py vil fungere korrekt.

1.2   Tegnsett

Tegnsett bør oppgies på strukturert format i starten av filen:

# -*- coding: utf-8 -*-

1.3   Lisens

Scripts bør inkludere lisenstekst

# Copyright 2015 University of Oslo, Norway
#
# This file is part of Cerebrum.
#
# Cerebrum is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# Cerebrum is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Cerebrum; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

1.4   Docstring

Scriptet bør dokumenteres i docstring på modul-nivå. Denne doc-stringen bør inneholde nok til å forklare hvilke endringer scriptet kan utføre, men bør også være kort nok til å skrives ut som hjelpetekst på kommandolinje.:

""" This script does nothing. """

2.1   Importer

Alle scripts i Cerebrum må importere følgende to moduler i riktig rekkefølge:

1. cerebrum_path
2. cereconf

Disse modulene bør importeres først, og må importeres før andre Cerebrum-moduler.

2.2   Logger

Loggeren bør hentes ut så tidlig som mulig, da den prosesserer sys.argv, og gjør endringer i hvordan logging, warnings og exceptions behandles.

Loggeren kan gjerne være global. Scripts uten særskilte logg-behov benytter loggeren cronjob.:

logger = Cerebrum.Utils.Factory.get_logger('cronjob')

2.3   Fil-eksport

Jobber som overskriver filer må bruke en Cerebrum.Utils.AtomicFileWriter. Dette fil-lignende objektet vil kun overskrive filer når den lukkes.

TODO: Note contextlib.closing TODO: Make context manager