計算の中身は変えても、呼び方は変えない——QDが共通の計算の名前と引数を固定し、変えるときは新しい名前で足す理由
▶ YouTube で見る(音つき・30秒)
穴の位置を測る関数に、単位を選ぶ引数を1つ足した。新しいマクロは正しく動いた。半年前に別の人が書いたマクロは同じ関数を古い呼び方で呼んでいて、エラーも出さずにインチの値で判定していた。社内でマクロが増えてくると、こうした事故はよく起きます。火曜日は設計思想の回です。QDが共通の計算の「呼び方」をどう決め、どう守っているかを書きます。
共通の関数を直すと、知らない所で古いマクロが変わる
同じ計算を何本ものマクロに書くのはやめて、共通の関数にまとめる。これは正しい方向です。直す場所が1か所になり、答えの食い違いも起きにくくなります。
ただ、まとめた関数には、まとめた分だけ使い手がいます。引数の順番を入れ替える、戻り値に項目を足す、既定の単位を変える。書いた本人には小さな直しでも、その関数を呼んでいる古いマクロからは見えません。
困るのは、壊れ方が静かなことです。エラーで止まれば気づけますが、引数の数が合ったまま意味だけが変わると、マクロは最後まで動いて、違う数字を表に書きます。見つかるのは、その表で判断したあとです。
名前・引数・戻り値を「呼び方」として固定する
QDでは、形を測る・比べる・切るといった共通の計算を、コマンドとは別の棚に置いています。いまは18の棚に260のファイル、呼び出せる関数は311あります。498のコマンドは、この棚の関数を名前で呼ぶだけで、中の計算には触りません。
この関数の名前・引数・戻り値の形を「呼び方」として固定しています。棚全体には版の番号を付け、どのファイルをどの順で組み立てたかを1つの表に書いています。
呼び方が決まっていれば、中身は直せます。速くする、精度を上げる、計算の方法そのものを入れ替える。どれも呼び方を変えない限り、498のコマンドの側は1行も書き換えずに済みます。
変えたいときは、新しい名前で足して古い方を残す
それでも呼び方を変えたくなることはあります。引数を足したい、戻り値の形を変えたい。QDの決まりでは、そのときは新しい名前で足し、古い方は残します。古い名前で呼んでいるコマンドは、前と同じ答えを受け取り続けます。
例を1つ挙げます。10月11日に、面に抜き勾配を付ける計算の方法を入れ替えました。点ごとに別々に解いていた方法から、まわりの面の条件をまとめて解く方法へ。名前・引数・戻り値はそのままにしたので、呼ぶ側の書き方を変える必要はありませんでした。
前の方法は、別の名前を付けて残しました。新しい方法の答えと並べて比べるためです。入れ替えた日に何がどれだけ変わったかを、同じ形で確かめられます。
中身は何度でも直す。
呼び方は、使う人がいる限り変えない。
def h(s): return hashlib.sha256(s.encode('utf-8')).hexdigest()[:16]
def main():
out = build() # 分けたファイルを、順番表のとおりに 1 本へつなぐ
cur = open(OUTP, encoding='utf-8').read() if os.path.exists(OUTP) else ''
if '--check' in sys.argv:
ok = cur == out
print('OK 組み立てた物と今の生成物は同じ' if ok else
'NG 組み立てた物と今の生成物が違う(直接直された? → 分けたファイルの側へ移して組み立て直す)')
sys.exit(0 if ok else 1)
last = M.get('builtHash')
if cur and last and h(cur) != last and cur != out and '--force' not in sys.argv:
print('止めました:生成物が前回の組み立ての後に直接直されています。直しを分けたファイルへ移してから、もう一度')
sys.exit(1)
open(OUTP, 'w', encoding='utf-8', newline='\n').write(out)
M['builtHash'] = h(out) # 次の組み立てで、直接の直しを見つけるための指紋組み立てた物は直接直さない——指紋で見つけて止める
棚の260のファイルは、順番表のとおりにつないで1本にしてから、画面にも試験にも読み込ませています。読む側は1本だけを見ればよく、分けたファイルの数が増えても読み方は変わりません。
ここで気をつけているのは、つないだ1本を直接直さないことです。急ぎの直しをつないだ側に入れると、次に組み立て直したときに黙って消えます。分けたファイルの側を直し、組み立て直すのが決まりです。
これを人の注意だけに任せないように、組み立てるたびに中身の指紋を残しています。次に組み立てる前に、今の1本の指紋が前回と違えば、直接直されたと分かるので止めます。順番表に載っていないファイルが棚にあるときも止めます。
呼び方だけで動くことを、毎晩確かめる
呼び方を固定しても、コマンドがこっそり中身に触っていれば意味がありません。そこで夜の検査では、コマンドごとに使うと書いた部品だけを積んで単体で流し、全部を積んだときと同じ答えになるかを見ています。
今朝(11月3日)の記録では、単体で流した422のコマンドのうち417が全部を積んだときと同じ答えでした。違ったのは5本で、基本の4本と形状生成の1本です。使う部品の書き出しが足りないのか、全部を積んだときの答えが古いのかは、まだ切り分けていません。
今日の数字も書いておきます。コマンドは498、段階は実用70(前日と同じ)・簡易306・試作104・未実装18。第2波の目標に届いたのは137本(28%)です。段階が下がったコマンドはありません。
import hashlib, json, math
API = {}
def api(name, version):
"""呼び方を登録する。同じ名前を2度登録したら止める(呼び方を黙って変えない)"""
def deco(fn):
if name in API:
raise RuntimeError(f'{name} はもうあります。呼び方を変えるときは新しい名前で足してください')
API[name] = {'fn': fn, 'version': version}
return fn
return deco
@api('draft_angle', '1.0')
def draft_angle(normal, pull=(0, 0, 1)):
"""面の向き(単位ベクトル)と抜き方向から、抜き勾配(度)を返す"""
dot = sum(a * b for a, b in zip(normal, pull))
return round(90 - math.degrees(math.acos(max(-1.0, min(1.0, dot)))), 3)
@api('draft_angle_many', '1.1')
def draft_angle_many(normals, pull=(0, 0, 1)):
"""まとめて測る呼び方は新しい名前で足す。古い draft_angle は残し、中で使う"""
return [draft_angle(n, pull) for n in normals]
def fingerprint(values):
return hashlib.sha256(json.dumps(values).encode()).hexdigest()[:12]
faces = [(1, 0, 0), (math.cos(math.radians(3)), 0, math.sin(math.radians(3))), (0, 0, 1)]
old = [draft_angle(n) for n in faces] # 前からの呼び方
new = draft_angle_many(faces) # 新しく足した呼び方
print('前の呼び方', old, fingerprint(old))
print('新しい呼び方', new, fingerprint(new))
print('同じ答え' if fingerprint(old) == fingerprint(new) else '答えが違う → 足すのを止める')
try:
@api('draft_angle', '2.0')
def draft_angle_v2(normal, pull, unit='rad'):
return 0
except RuntimeError as e:
print('止めました:', e)
# 前の呼び方 [0.0, 3.0, 90.0] 98de7e19f0eb
# 新しい呼び方 [0.0, 3.0, 90.0] 98de7e19f0eb
# 同じ答え
# 止めました: draft_angle はもうあります。呼び方を変えるときは新しい名前で足してくださいお客様のマクロにも、同じ決まりを持ち込む
この決まりは、QDの中だけの話ではありません。いつもの3次元CADのマクロでも、共通の関数を持った時点で同じことが起きます。私たちがマクロの整理をお手伝いするときは、まず共通の関数の一覧を作り、どのマクロがどの呼び方で使っているかを書き出します。
そのうえで、変えたい関数は新しい名前で足し、古い呼び方を使うマクロを1本ずつ移します。全部が移り終わるまでは、古い方を消しません。移す前と後で、同じ部品に流した答えが同じかを確かめるのも、QDと同じやり方です。
最初は、お手元のマクロを数本お預かりし、共通の関数とその使い手を一覧にするところから始めています。ヒアリングと自働化設計書のご提案までは無料です。QDで確かめられることの全体は、製品ページQRONIX QDにまとめています。
記事一覧をすべて見る →