所有権
関数に文字列を渡し、その関数が保持してよいようにするには、所有する値を渡します。Pythonではリストを別の名前へ代入すると、二つの名前が同じリストを指します。Nagiでは、値を手放す・読むために貸す・同じ値を共有する操作を区別します。
def use_name(name: str):
print(name)
def main():
name = "alice"
use_name(name)
# print(name) はmove後の使用
この完全なコードはaliceを表示します。呼び出した後、元のnameではその文字列を使えません。この引き渡しをmoveと呼び、後片付けの責任も新しい所有者へ移ります。moveそのものがcloseや破棄を行うわけではありません。
コメントを外してprint(name)を追加すると、move後の使用としてcheckが拒否します。読むだけなら、引数をview[str]にしてview(name)を渡します。独立した文字列が必要ならcopy(view(name))を渡します。入門の実行例で試せます。
よくある誤りと二つの直し方を、短い例で確認します。
from std.ownership import move
def show(name: view[str]):
print(name)
def main():
name = "Nagi"
destination = move(name)
print(name) # checkはnameに値がないため拒否
destinationへ渡した値を使うならprint(destination)に直します。両方の名前を使いたい場合はdestination = copy(view(name))で明示的に複製するか、show(view(name))で借用してからnameを使います。move後に元のbindingが再び値を持つわけではありません。
このページの目次
代入と明示move
以下の明示moveと代入規則はNagi 0.1.11で公開済みです。利用するcompilerが0.1.11以降であることを確認してください。Pythonの代入は同じ値への参照を増やします。Nagiでは、数値やboolなどCopyとして扱う値は通常代入できます。既存の非Copyローカルを渡す場合はmoveを使い、裸のdestination = nameは拒否します。
moveを書くのは、代入によって元の変数から値を手放すことを示すためです。元も使いたい場合のcopyやshared化を、コンパイラが代わりに選ぶことはありません。
from std.ownership import move
def main():
count = 2
same_count = count
print(count + same_count)
name = "Nagi"
destination = move(name)
print(destination)
name = "new"
print(name)
出力は4、Nagi、newです。destination = move(name)は所有権と後片付けの責任を渡します。ソース上ではcloneやshared handleの追加を要求しませんが、転送が実行時コストゼロであるとは保証されません。
move後、再代入前にnameを読むと拒否されます。変数名自体が使えなくなるのではなく、新しい値を受け取った後なら再利用できます。元の文字列も残したい場合は、上のmove代入をdestination = copy(view(name))へ置き換えます。読むだけならview(name)、同じ値を複数の場所で持つならshareとclone_sharedを使います。
name = "Nagi"やa = User(...)のように新しい値を作る場合、move指定は不要です。この変更の対象は、宣言・型注釈・再代入の右辺が所有する非Copyローカルそのものの場合で、括弧で包んでも同じです。引数、return、フィールド・index取り出し、try、matchは既存のconsume規則を保ちます。move(name)を引数やreturnに使っても、借用の制約は回避できません。
Copy型ならmove(count)と書いても、元のcountを引き続き使えます。Copy規則は変更しません。view、関数値（対応済みのローカルasync関数別名を含む）、UUID、timestampや、中身がCopyのclass・enum・nullable・ownedも対象です。Resultとsharedは、中身がCopyでも非Copyです。viewをCopyしても借用元は必要で、関数値のCopyはFutureの保存を許すものではありません。型、async、設計判断を参照してください。
moveはstd.ownershipからimportする、引数一つの操作です。型は入力から推論し、明示型引数は受け付けません。import std.ownership as ownershipからのownership.move(name)、from std.ownership import move as transferからのtransfer(name)も使えます。同名のユーザー関数は通常の関数として扱います。標準操作そのものの第一級関数値化は未対応です。borrowed/shared親の非Copyフィールドは奪えません。Futureや入れ子のFutureは入力にできませんが、move(await operation(...))はawait後の結果型が対応範囲なら使えます。
同じ値を複数の場所で持つ
独立したコピーではなく、同じ値を複数箇所で保持したいときはshareとclone_sharedを使います。Pythonの二つの名前への参照代入では不要な、明示的な操作です。次は文字列フィールドを持つclassを使った完全な例です。
class Label:
text: str
def main():
label = share(Label(text="Nagi"))
another = clone_shared(label)
duplicate = copy(view(another.text))
print(label.text)
print(duplicate)
出力はNagi、Nagiです。share(value)は所有値を受け取り、shared[T]を返します。clone_shared(label)は同じ値を保持するhandleを増やし、中身全体はコピーしません。copy(view(another.text))は、それとは別に所有文字列を作ります。
text = another.textで共有値から非Copyフィールドを奪おうとすると、checkが拒否します。読むか、上のようにコピーしてください。sharedの通常の参照から任意の書き換えはできません。内部に状態を持つ資源は、同期や操作条件を定めたAPIを使います。sharedに包んでも任意のTがthread-safeになるわけではなく、共有や独立copyができない資源もあります。組み込み関数と並行処理を参照してください。
最後のshared handleが値を解放することと、外部サービスの停止が完了することは別です。共有参照が循環すると値を保持し続ける場合もあり、任意の共有グラフが自動回収される保証はありません。終了完了が必要なら、その資源のshutdown／close APIで確認します。
classのフィールドを取り出す
文字列のフィールドを別の変数へ代入すると、その文字列の所有権が移ります。移動したフィールドは再利用できませんが、移動していない別のフィールドは使えます。
class Person:
name: str
age: i64
def main():
person = Person(name="Nagi", age=1)
name = person.name
print(name)
print(person.age)
# print(person.name) はmove後の使用
元のフィールドも残したい場合は、上の代入をname = copy(view(person.name))に変更します。コピーはmoveする前に作ってください。printやlenで読み取るだけなら、文字列はmoveしません。
関数に読み取り用の値を渡す例は、読むだけならviewで借りるにあります。
ループで同じ値を使う
ループの外で作った文字列を、毎回所有値として渡すと、1周目でmoveして次の周回で使えなくなります。checkはこの再利用を拒否します。フィールドを取り出す場合や、whileの条件で値を渡す場合も同じです。
元の値を残して渡すには、周回ごとにコピーを作ります。読むだけの関数なら、引数をview[str]にしてview(name)を渡せます。
def use_name(name: str):
print(name)
def main():
name = "Nagi"
for number in range(2):
use_name(copy(view(name)))
print(name)
次の周回までに新しい値を代入する方法もあります。
def use_name(name: str):
print(name)
def main():
name = "first"
for number in range(2):
use_name(name)
name = "next"
print(name)
分岐で再代入する場合は、次の周回へ進むすべての経路で値を用意してください。returnで関数を終える経路は、次の周回や後続の処理へ影響しません。ループ内で新しく作った値は周回ごとに使えます。
検査は実行回数を計算せず、繰り返しと0回の実行を考慮します。そのため、ループ内の代入だけでは、ループ後に値が使えるとは限りません。whileの条件は、ループを抜けるときにも評価されます。
借用と検査の範囲
for value in valuesは、走査する配列を借用します。次の周回へ進む経路では、その配列のappend・再代入・moveをcheckで拒否します。view(values)や、そのviewを変数に入れて走査する場合も同じです。別の配列は変更でき、ループが終了すれば走査の借用は終わります。
def main():
values = [1, 2]
output: List[i64] = []
for value in values:
append(output, value * 2)
append(values, 3)
数値などのCopy要素は、ループ変数へ値をコピーします。文字列を持つclassなど、非Copy要素は読み取り専用で借用します。反復のために文字列やclassを複製しません。
class User:
name: str
score: i64
def main():
users = [User(name="Nagi", score=10)]
for user in users:
print(user.name)
print(user.score)
name = copy(view(user.name))
print(name)
append(users, User(name="凪", score=20))
借用した要素は再代入できず、要素全体や非Copyフィールドを所有値として関数へ渡したり、返したりできません。文字列や配列を手元に残す場合は、上の例のようにフィールドを明示的にcopyします。ループ内で作ったフィールドのviewをループの外へ保存することもできません。非Copy enum・nullable・Resultのpayloadをmatchで取り出す借用は、まだ未対応です。
フィールドの借用は場所ごとに追跡します。例えばview(data.values)が生きていても、別のdata.nameを取り出せます。data全体やdata.valuesの移動はできません。
viewが借りているデータの移動・再代入・appendも制限します。借用はコードのブロックをもとに追跡します。Rustほど細かく、借用を使い終わった位置を判定するわけではありません。
viewを含む戻り値でも、return Noneやreturn []、return ok(None)のように借用を含まない値を直接返せます。viewを含む型のローカル変数を返す場合は、現在の値が空でも借用元を追跡できる必要があります。
returnで終わるブロックの直下では、viewを一時的にローカル値へ切り替え、その後で引数のviewに戻して返せます。生成Rustでは、各代入を別の借用として扱います。分岐後や次のループで使う値の更新は維持し、所有値のコピーは追加しません。実行テストでHigh・保存Low・手書きLowを確認しています。修正の収録状況はCHANGELOGを参照してください。
借用を含むList・Result・Optionを一時的にローカル値へ切り替え、引数の借用へ戻して返せます。別の変数へのmove、入れ子の値、if／matchの分岐、for／while、asyncも対象です。生成時に代入前後の格納先を分け、右辺の評価後に古い値を解放します。所有値のコピーで寿命を延ばす処理は追加しません。生成と実行のテストと確保・破棄のテストでHigh・保存Low・手書きLowを確認しています。収録版はCHANGELOGに記載します。
この処理をscope内で行う場合も、正常終了、エラー伝播、親タスクの取消し、本体のpanicを実ランタイムのテストで確認しています。通常のエラー出口では子の取消完了を待ちます。親Futureの破棄やpanicでは停止を要求しますが、同期的な破棄だけで子の終了完了までは待てません。
借用を復元すれば任意のコードが通るわけではありません。checkerは、局所的な借用が外へ漏れないことを引き続き検査します。たとえば借用を含むローカル変数の返却では、値が現在空でも追跡できる借用元が必要です。利用者が定義する借用を含むclass・enumや、任意のasync関数値は未対応です。
Nagiの検査は、Nagiのソース位置でmoveや借用の診断を返すためのものです。生成Rustの検査を代替するものではありません。また、checkがRust側なら有効なコードを保守的に拒否する場合もあります。
Rustアダプターとの型の一致、copyに必要なClone、非同期処理のSend・共有状態のSyncも最終的にはbuildで検査します。shared[T]で包むだけでTが並行処理に適した型になるわけではありません。実行ファイルを作るにはNagiとRustの両方の検査を通す必要があります。
元のデータとは別に保持したいときは、copy(view(data))で所有するコピーを作ります。