ARCHIV

SCONS - Nástroj pro sestavování software - 6

Export a import proměných z environmentu operačního systému.

9.8.2010 00:00 | Radim Kolář | Články autora | přečteno 6817×

Práce s proměnnými environmentu

Podobně jako má SCons svá prostředí, tak je má i operační systém. Tomuto prostředí se nejčastěji říká v češtině environment. Prostředí operačního systému je podobně jako prostředí v SConsu. Jedná se o seznam klíčů a k nim přiřazeným hodnotám. V Unixu si ho můžeme vypsat příkazem env.

fbsd8:~> env
PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin
TERM=xterm
SHELL=/bin/tcsh
HOSTTYPE=FreeBSD
MACHTYPE=i386
SHLVL=1
EDITOR=vi
PAGER=more
JAVA_HOME=/usr/local/jdk1.5.0
ANT_HOME=/usr/local/share/java/apache-ant

Jedním z design prvků nástroje SCons byl požadavek na stabilní buildy. To znamená že buildy jsou nezávislé na nastavených proměnných environmentu. SCons ukládá hodnoty které bude exportovat do prostředí operačního systému při spoustění externích programů do proměnné s názvem ENV. Do této proměnné není automaticky přidán obsah environmentu. Standardně obsahuje jen proměnnou PATH a vypadá takto:

fbsd8:/tmp> cat SConstruct
env=Environment()
print env.get('ENV')
fbsd8:/tmp> scons -Q
{'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}
scons: `.' is up to date.

Pokud chceme vyexportovat celý environment ve kterém jsme spustili SCons tak to se dá udělat velmi snadno. Naimportujeme Python modul os, který obsahuje prostředí v dictionary environ.

env=Environment()
import os
env.Replace(ENV = os.environ)

Toto se ale nedoporučuje používat protože tím ztratíme nezávislost na prostředí ve kterém SCons spouštíme.

Lepší je proto nastavovat jen ty proměnné které potřebujeme. V naprosté většině případů vystačíme jen s exportem proměnných PATH, LD_LIBRARY_PATH a LIBPATH a nejpoužívanější akcí kterou budeme muset provádět je přidávat do těchto proměnných adresáře. SCons je na toto vybaven a prostředí poskytuje k tomu dvě metody PrependENVPath a AppendENVPath, které přidávají hodnotu za začátek či konec proměnných. Oddělovač jednotlivých hodnot uvádět nemusíme, SCons ho přidá automaticky v závislosti na jakém operačním systému běží.

env=Environment()
print env.get('ENV')['PATH']
env.AppendENVPath( 'PATH', '/usr/local/sbin')
print env.get('ENV')['PATH']

fbsd8:/tmp> scons -Q
/usr/local/bin:/opt/bin:/bin:/usr/bin
/usr/local/bin:/opt/bin:/bin:/usr/bin:/usr/local/sbin
scons: `.' is up to date.

Při přídávání můžeme použít místo řetězce seznam a přidat tak více adresářů na jeden zátah. Speciální znak # označuje kořenový adresář námi sestavovaného projektu. Pokud máme v projektu skripty které potřebujeme při sestavování spouštět, tak použijeme následující.

env=Environment()
env.AppendENVPath( 'PATH', ['/usr/local/sbin','#/scripts'] )
print env.get('ENV')['PATH']

fbsd8:/tmp> scons -Q
/usr/local/bin:/opt/bin:/bin:/usr/bin:/usr/local/sbin:scripts
scons: `.' is up to date.

Ne vždy chceme jen přidávat do proměnných typu path. Občas je nutné nastavit proměnnou na předem definovanou hodnotu. Toho nejlépe dosáhneme takto:

fbsd8:/tmp> cat SConstruct
env=Environment()
env.Append(ENV = {'CFLAGS':"-O2"})
print env.get('ENV')['CFLAGS']
env.Append(ENV = {'CFLAGS':"-O2"})
print env.get('ENV')['CFLAGS']
fbsd8:/tmp> scons -Q
-O2
-O2
scons: `.' is up to date.

Vidíme, že ačkoliv jsme použili metodu Append a zavolali ji se stejnou hodnotou dvakrát tak položka CFLAGS environmentu obsahuje -O2 jen jednou. Pokud potřebujeme opravdu hodnotu přidat tak podobný trik se seznamem co jsme používali v prostředích SCons nejde použít. Místo toho musíme vypsat při volání Append dosavadní hodnotu.

fbsd8:/tmp> cat SConstruct
env=Environment()
env.Append(ENV = {'CFLAGS':"-O2"})
print env.get('ENV')['CFLAGS']
env.Append(ENV = {'CFLAGS':env['ENV']['CFLAGS']+" -march=i386"})
print env.get('ENV')['CFLAGS']
fbsd8:/tmp> scons -Q
-O2
-O2 -march=i386
scons: `.' is up to date.

Pokud chceme nastavit hodnotu proměnné environmentu na hodnotu, kterou měla při spuštění SCons tak je dobré otestovat její existenci aby nám neskončil scons s vyjímkou KeyError. Můžeme si do podmínky dát nastavení default hodnoty v případě že proměnná nastavena není. Hodnotu environmentu zjistíme v python modulu os, kde se nachází v dictionary environ.

import os
env=Environment()
if 'SHELL' in os.environ:
    env.Append(ENV = {'SHELL':os.environ['SHELL']})
else:
    env.Append(ENV = {'SHELL':'sh'})
print env.get('ENV')

Důležité proměnné prostředí SCons

A na závěr bude slibovaná tabulka proměnných. Nejsou to všechny proměnné, které SCons nastavuje a používá, ale jen ty nejdůležitější. Pokud vás zajímá seznam všech proměnných které se standardně v prostředí SCons nastaví po inicializaci prostředí, tak ty si můžeme vypsat pomocí toho SConscructu.

env=Environment()
var=env.Dictionary().keys()
var.sort()
for key in var:
  print key,'=',env[key]

Proměnná	Význam
CC	překladač jazyka C
CCFLAGS	přepinače překladače C a C++
CFLAGS	přepinače překladače C
CCVERSION	verze překladače C (automaticky detekováno)
CCCOM	příkazová řádka pro vyvolání kompilace C s přepínači
AR	program pro vytváření knihoven
ARFLAGS	přepínače při přidání objektu do knihovny
ARCOM	příkazová řádka pro vyvolání AR
CPPFLAGS	přepínače C preprocesoru CPP
CXX	Překladač jazyka C++
CXXFILESUFFIX	koncovka zdrojových textů C++ programů
CXXFLAGS	přepínače překladače C++
CXXVERSION	verze C++ překladače
CXXCOM	příkazová řádka překladače C++
JAVAC	překladač jazyka Java
JAVACFLAGS	přepínače překladače Java
JAVACLASSPATH	CLASSPATH použitá při překladu Java programů
LEX	Program lex kompatibilní
LEXCOM	Příkazová řádka LEXu
YACC	Program bison kompatibilní
YACCCOM	Příkazová řádka bisona

Závěr

Po dnešku již umíme importovat a exportovat z environmentu operačního systému. Příště se podíváme na autokonfiguraci voleb kompilátoru podobně jako se to dělá v programu GNU Autoconf.

Verze pro tisk