setup.py

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

import os
import imp
import logging
import platform
import shutil
import sys

from stat import *
from string import *

from distutils.core import setup
from distutils.extension import Extension
from distutils.command import clean
from distutils.sysconfig import get_python_lib

logger = logging.getLogger()
#logger.addHandler(logging.StreamHandler(sys.stderr))
logging.basicConfig(level=20)

# PySlurm Version

#VERSION = imp.load_source("/tmp", "pyslurm/__init__.py").__version__
__version__ = "2.6.3-0pre2"
__slurm_hex_version__ = "0x0206"

def fatal(logstring, code=1):
	logger.error("Fatal: " + logstring)
	sys.exit(code)

def warn(logstring):
	logger.error("Warning: " + logstring)

def info(logstring):
	logger.info("Info: " + logstring)

def usage():
	info("Need to provide either SLURM dir location for build")
	info("Please use --slurm=PATH or --slurm-lib=PATH and --slurm-inc=PATH")
	info("i.e If slurm is installed in /usr use :")
	info("\t--slurm=/usr or --slurm-lib=/usr/lib64 and --slurm-inc=/usr/include")
	info("For now if using BlueGene cluster set the type with --bgl --bgp or --bgq")
	sys.exit(1)

def scandir(dir, files=[]):

	"""
	Scan the directory for extension files, converting
	them to extension names in dotted notation
	"""

	for file in os.listdir(dir):
		path = os.path.join(dir, file)
		if os.path.isfile(path) and path.endswith(".pyx"):
			files.append(path.replace(os.path.sep, ".")[:-4])
		elif os.path.isdir(path):
			scandir(path, files)
	return files

def makeExtension(extName):

	"""Generate an Extension object from its dotted name"""

	extPath = extName.replace(".", os.path.sep) + ".pyx"
	return Extension(
		extName,
		[extPath],
		include_dirs = ['%s' % SLURM_INC, '.'],   # adding the '.' to include_dirs is CRUCIAL!!
		library_dirs = ['%s' % SLURM_LIB], 
		libraries = ['slurm'],
		runtime_library_dirs = ['%s/lib' % SLURM_LIB],
		extra_objects = [],
		extra_compile_args = [],
		extra_link_args = [],
	)

def read(fname):

	"""Read the README.rst file for long description"""

	return open(os.path.join(os.path.dirname(__file__), fname)).read()

def read_inc_version(fname):

	"""Read the supplied include file and extract slurm version number
	in the line #define SLURM_VERSION_NUMBER 0x020600 """

	hex = ''
	f = open(fname, "r")
	for line in f:
		if line.find("#define SLURM_VERSION_NUMBER") == 0:
			hex = line.split(" ")[2].strip()
			info("Build - Detected Slurm include file version - %s" % hex)

	return hex

def clean():

	"""Cleanup build directory and temporary files"""

	info("Clean - checking for objects to clean")
	if os.path.isdir("build/"):
		info("Clean - removing pyslurm build temp directory ...")
		try:
			shutil.rmtree("build/")
		except:
			fatal("Clean - failed to remove pyslurm build/ directory !") 
			sys.exit(-1)

	files = [ "pyslurm/pyslurm.c", "pyslurm/bluegene.pxi" ]

	for file in files:

		if os.path.exists(file):

			if os.path.isfile(file):
				try:
					info("Clean - removing %s temp file" % file)
					os.unlink(file)
				except:
					fatal("Clean - failed to remove %s temp file" % file)
					sys.exit(-1)
			else:
				fatal("Clean - %s temp file not a file !" % file)
				sys.exit(-1)

	info("Clean - completed")

#
# Main section
#

info("")
info("Building PySlurm (%s)" % __version__)
info("------------------------------")
info("")

if sys.version_info[:2] < (2, 6):
	fatal("PySlurm %s requires Python version 2.6 or later (%d.%d detected)." % (__version__, sys.version_info[:2]))

compiler_dir = os.path.join(get_python_lib(prefix=''), 'src/pyslurm/')

try:
	from Cython.Distutils import build_ext
	from Cython.Compiler.Version import version as CyVersion

	info("Cython version %s installed\n" % CyVersion)

	if CyVersion < "0.15":
		fatal("Please use Cython version >= 0.15")
except:
	fatal("Cython (www.cython.org) is required to build PySlurm")

#
# Set default Slurm directory to /usr
#

DEFAULT_SLURM = '/usr'
SLURM_DIR = SLURM_LIB = SLURM_INC = ''

#
# Handle flags but only on build section
#
#    --slurm=[ROOT_PATH] | --slurm-lib=[LIB_PATH] && --slurm-inc=[INC_PATH]
#

args = sys.argv[:]
if args[1] == 'clean':

	#
	# Call clean up of temporary build objects
	#

	clean()

if args[1] == 'build':

	#
	# Call clean up of temporary build objects
	#

	clean()

	for arg in args:
		if arg.find('--slurm=') == 0:
			SLURM_DIR = arg.split('=')[1]
			sys.argv.remove(arg)
		if arg.find('--slurm-lib=') == 0:
			SLURM_LIB = arg.split('=')[1]
			sys.argv.remove(arg)
		if arg.find('--slurm-inc=') == 0:
			SLURM_INC = arg.split('=')[1]
			sys.argv.remove(arg)

		BGL = BGP = BGQ = 0
		if arg.find('--bgl') == 0:
			BGL=1
			sys.argv.remove(arg)
		if arg.find('--bgp') == 0:
			BGP=1
			sys.argv.remove(arg)
		if arg.find('--bgq') == 0:
			BGQ=1
			sys.argv.remove(arg)

	# Slurm installation directory

	if SLURM_DIR and (SLURM_LIB or SLURM_INC):
		usage()
	elif SLURM_DIR and not (SLURM_LIB or SLURM_INC):
		SLURM_LIB = "%s/lib" % SLURM_DIR
		SLURM_INC = "%s/include" % SLURM_DIR
	elif not SLURM_DIR and not SLURM_LIB and not SLURM_INC:
		SLURM_LIB = "%s/lib" %  DEFAULT_SLURM
		SLURM_INC = "%s/include" %  DEFAULT_SLURM
	elif not SLURM_DIR and not (SLURM_LIB or not SLURM_INC):
		usage()

	# Test for slurm lib and slurm.h maybe from derived paths ?

	if not os.path.exists("%s/slurm/slurm.h" % SLURM_INC):
		info("Build - Cannot locate the Slurm include in %s" % SLURM_INC)
		usage()

	if read_inc_version("%s/slurm/slurm.h" % SLURM_INC)[:len(__slurm_hex_version__)] != __slurm_hex_version__:
		fatal("Build - Incorrect slurm version detected, Pyslurm needs Slurm-2.6.0")
		sys.exit(-1)

	if not os.path.exists("%s/libslurm.so" % SLURM_LIB):
		info("Build - Cannot locate the Slurm shared library in %s, checking lib64 .... " % SLURM_LIB)
		SLURM_LIB = "%s/lib64" %  DEFAULT_SLURM
		if not os.path.exists("%s/libslurm.so" % SLURM_LIB):
			info("Build - Cannot locate the Slurm shared library in %s" % SLURM_LIB)
			usage()

	# BlueGene Types

	if (BGL + BGP + BGQ) > 1:
		fatal("Please specifiy one BG Type either --bgl or --bgp or --bgq")
	else:
		info("Build - Generating pyslurm/bluegene.pxi file")
		try:
			f = open("pyslurm/bluegene.pxi", "w")
			f.write("DEF BG=1\n")
			f.write("DEF BGL=%d\n" % BGL)
			f.write("DEF BGP=%d\n" % BGP)
			f.write("DEF BGQ=%d\n" % BGQ)
			f.close()
		except:
			fatal("Build - Unable to write Blue Gene type to pyslurm/bluegene.pxd")
			sys.exit(-1)

# Get the list of extensions

extNames = scandir("pyslurm/")

# Build up the set of Extension objects

extensions = [makeExtension(name) for name in extNames]

setup(
	name = "pyslurm",
	version = __version__,
	license="GPL",
	description = ("Slurm Interface for Python"),
	long_description=read("README.rst"),
	author = "Mark Roberts",
	author_email = "mark@gingergeeks co uk",
	url = "http://www.gingergeeks.co.uk/pyslurm/",
	platforms = ["Linux"],
	keywords = ["Batch Scheduler", "Resource Manager", "Slurm", "Cython"],
	packages = ["pyslurm"],
	ext_modules = extensions,
	cmdclass = {"build_ext": build_ext },
	classifiers = [
		'Development Status :: 4 - Beta',
		'Environment :: Console',
		'License :: OSI Approved :: GPL',
		'Intended Audience :: Developers',
		'Natural Language :: English',
		'Operating System :: Linux',
		'Programming Language :: Python',
		'Programming Language :: Python :: 2.6',
		'Programming Language :: Python :: 2.7',
		'Programming Language :: Python :: 3.1',
		'Programming Language :: Python :: 3.2',
		'Programming Language :: Python :: 3.3',
		'Topic :: Software Development :: Libraries',
		'Topic :: Software Development :: Libraries :: Python Modules',
	]
)