private

private は、その定義があるファイルの中でだけ参照可能になるようにする修飾子です。他のファイルからはアクセス不能になります。

不安定なAPIなど、外部に公開したくないものに対して使うのが主な用途です。

import LeanByExample.Reference.Declarative.Protected -- protected のページをインポート
import Lean

-- protected の項で private を使わずに定義した内容にアクセスできる
#check Point.sub

-- private とマークした定義にはアクセスできない
#check_failure Point.private_sub

なお private コマンドでセクションや名前空間にスコープを制限することはできません。

namespace Hoge
  section
    -- private とマークした定義
    private def addOne (n : Nat) : Nat := n + 1

  end
end Hoge

open Hoge

-- 外からでもアクセスできる
#check addOne

補足

private コマンドを用いて宣言した名前は、そのファイルの外部からはアクセス不能になるものの、そのファイル内部からは一見 private でない名前と同様に見えます。しかし、特定の名前が private であるか判定する関数は存在します。

private def hoge := "hello"

def foo := "world"

-- 名前が private かどうか判定する関数
#check (Lean.isPrivateName : Lean.Name → Bool)

#guard Lean.isPrivateName ``hoge

#guard Lean.isPrivateName ``foo = false