SPSS Modelerのデフォルトディレクトリの使い方とデータへのファイルパス違いの対応方法

SPSS Modelerで他の人からもらったストリームを実行するときにデータへのファイルパスが違って実行ができないことがあると思います。デフォルト・ディレクトリの設定をつかってファイルパスを手で修正しないで実行する方法を紹介します。

作ったbatやpythonスクリプト、サンプルストリームは以下に置きました。

■テストした環境
Modeler 18.2.2
Windows 10

1.デフォルトディレクトリ

SPSS Modelerの可変長ファイルなどの入力ノードを読むときのデフォルトのディレクトリが設定されています。デフォルトの設定は、WindowsではC:\ProgramDataです。しかしながら、このフォルダにデータを置く人はあまりいないと思うので不便だと思います。

これをModelerのメニューから変える場合は、ファイルのディレクトリの設定を選びます。

例えば、自分のドキュメントフォルダなどに設定しておくのが使いやすいかと思います。

設定をしておくと、可変長ファイルなどの入力ノードでデータを探す起点が変更できます。

また、パスの指定をデフォルトパスからの相対パスで指定ができます。
通常は以下の「C:\Users\dsuser01\Documents\テスト\iris.csv」というような絶対パスです。

しかしながら、以下のように「テスト\iris.csv」のような相対パスで指定が可能です。

なお、一度設定したデフォルト・ディレクトリは
C:\Users<ユーザー名>\AppData\Roaming\IBM\SPSS\Modeler\18.2.2\Defaults\session.prefsに保存されますので次回起動した際にも有効になります。

# 2021-04-30 01:18:21-0500
DefaultWorkingDirectories=C\:\\Users\\dsuser01\\Documents

2. デフォルトディレクトリを簡単に設定する

相対パスで指定しておくと、他の人が同じデータとストリームを別のマシンで実行する場合に、絶対パスが完全に揃っていなくても参照が可能です。
特にファイル名だけの指定になっていると、フォルダの構成の全く異なる他の人のマシンでもパスを書き換えなくてもすぐにストリームを動作させることができます。
しかしながら、デフォルトディレクトリをいちいち変更するのは結構面倒です。

そこで以下のようなバッチファイルを作りました。

modelercur.bat

@echo off
setlocal
SET MODELERPATH="C:\Program Files\IBM\SPSS\Modeler\18.2.2\bin\modelerclient.exe"

REM カレントディレクトリの取得
for /f "usebackq delims=" %%A in (`CHDIR`) do set CDIR=%%A
echo %CDIR%
echo %1\
REM 引数がフォルダであることを判定
for /f "usebackq delims=" %%A in (`powershell Test-Path -PathType container %1`) do set CONTAINTER=%%A
echo %CONTAINTER%

if  %CONTAINTER%==True (
  echo "direcotry"
  REM 引数をデフォルトディレクトリとしてModelerを起動
  start "" %MODELERPATH% -directory "%1"
) else (
  echo "file"
  REM カレントディレクトリをデフォルトディレクトリとしてModelerを起動。引数のstrファイルを開く
  start "" %MODELERPATH% -directory "%CDIR%" -stream "%1"
) 

SET MODELERPATH="C:\Program Files\IBM\SPSS\Modeler\18.2.2\bin\modelerclient.exe"はお使いのmodelerclient.exeのパスを指定してください。

このファイルをC:\Users\＜ユーザー名＞\AppData\Roaming\Microsoft\Windows\SendToに保存します。

そして開きたいstrファイルを選んで、右クリックの送るからmodelercur.batを選びます。
ここではC:\Users\dsuser01\Documents\テストのtest.strを開いています。データは同じフォルダのiris.csvに置いてあります。

起動したModelerのデフォルトディレクトリの設定を見るとC:\Users\dsuser01\Documents\テストになっています。

ですので、ファイル名だけでデータが参照できました。

また、strファイルではなく、フォルダを選んで右クリックの送るからmodelercur.batを選んだ場合は、そのフォルダがデフォルトディレクトリとしてセットされてModelerが起動します。
ここではC:\Users\dsuser01\Documents\テスト２を選んでいます。

起動したModelerのデフォルトディレクトリの設定を見るとC:\Users\dsuser01\Documents\テスト２になっています。

３．既存ストリームの絶対パスを相対パスに置き換える。

デフォルトディレクトリさえ設定してあれば、他の人からもらったstrファイルやエクスポートノードのパスを相対パスに変えてしまえば、すぐに開いてみることができます。

これを、以前書いたファイルパスを一括変換するmodelerスクリプトを修正して作りました。

changecurrelpath.py

import modeler.api
import os

for stream in modeler.script.streams():
    print("stream:"+stream.getName().encode('utf-8'))
    #streamfilenpath=stream.getLastSavedAs()
    #newpath=os.path.dirname(streamfilenpath)

    #session=modeler.script.session()
    #newpath=session.getDefaultDataDirectory()
    #print("newpath:"+newpath.encode('utf-8'))

    for node in stream.iterator():
        if (node.getTypeName() == "variablefile"
            or node.getTypeName() == "excelimport"
            or node.getTypeName() == "statisticsimport"
            or node.getTypeName() == "outputfile"
            or node.getTypeName() == "excelexport"
            or node.getTypeName() == "statisticsexport"):
            full_filename=node.getPropertyValue("full_filename")
            print("old:"+full_filename.encode('utf-8'))
            #full_filename=newpath+"\\"+os.path.basename(full_filename)
            full_filename=os.path.basename(full_filename)
            print("new:"+full_filename.encode('utf-8'))
            node.setPropertyValue("full_filename",full_filename)

新規のファイル名をos.path.basename(full_filename)でファイル名だけにしています。

テスト実行してみます。
以下のストリームでは入力ノードのファイルがC:\Users\dsuser01\Documents\テスト\iris.csvのように絶対パスで設定されています。

ツールのメニューからスタンドアロンスクリプトを開きます。

changecurrelpath.pyのpythonスクリプトを貼付け、実行します。デバッグを見ると変換の行われた入力が出力されます。

ファイル名が相対パスのファイル名だけに変換されています。

なお、閉じるときにスタンドアロンスクリプトを保存するかを聞かれますが、保存する必要はありません。

4. 相対パス変換までの自動化

さらに、２．デフォルトディレクトリを簡単に設定するバッチをもう少し変更して、３のchangecurrelpath.pyを自動的に実行するようにしてみます。

まず、changecurrelpath.pyをC:\Users\＜ユーザー名＞\AppData\Roaming\Microsoft\Windows\SendToに保存します。

そして以下のバッチファイルも作り、同じくC:\Users\＜ユーザー名＞\AppData\Roaming\Microsoft\Windows\SendToに保存します。

modelercurreplace.bat

@echo off
setlocal
SET MODELERPATH="C:\Program Files\IBM\SPSS\Modeler\18.2.2\bin\modelerclient.exe"
SET MODELERSCRIPT="%AppData%\Microsoft\Windows\SendTo\changecurrelpath.py"

REM カレントディレクトリの取得
for /f "usebackq delims=" %%A in (`CHDIR`) do set CDIR=%%A
echo %CDIR%
echo %1\
REM 引数がフォルダであることを判定
for /f "usebackq delims=" %%A in (`powershell Test-Path -PathType container %1`) do set CONTAINTER=%%A
echo %CONTAINTER%

if  %CONTAINTER%==True (
  echo "direcotry"
  REM 引数をデフォルトディレクトリとしてModelerを起動
  start "" %MODELERPATH% -directory "%1"
) else (
  echo "file"
  REM カレントディレクトリをデフォルトディレクトリとしてModelerを起動。引数のstrファイルを開き相対パスに書き換えるスクリプトを実行する
  start "" %MODELERPATH% -directory "%CDIR%" -stream "%1" -script "%MODELERSCRIPT%" -execute
)

先ほどとの違いは、カレントディレクトリをデフォルトディレクトリに設定してstrファイルを開くだけではなく、スタンドアロンスクリプトとして、changecurrelpath.pyを実行して、すべてのパスを相対パスに置き換えていることです。

start "" %MODELERPATH% -directory "%CDIR%" -stream "%1" -script "%MODELERSCRIPT%" -execute

以下のようにSendToの下に保存します。

テスト実行してみます。
相対パスに書き換えたいstrファイルを選び、右クリックの送るからmodelercurreplace.batを選びます。

カレントディレクトリをデフォルトディレクトリとしてModelerが起動し、strファイル内の入力ノードの絶対パスが相対パスに書き換わりました。

これでstrファイルとデータファイルを同じフォルダに入れておけば、手でパスを修正しなくても動かすことができます。