[Python] sys.path.insertとは？

Question

色々ググってみても、公式ドキュメントにすら、記述されてないので、
最後の砦、でテラテイルで質問させていただきます。

sys.path.insertってどのような働きをするんですか？
例えば、下記のコードを実行すると、どうなるんですか？

import sys
folder_path = "C:\Users\document\my_code\"
sys.path.insert(0, folder_path)

日本語、英語で検索しても、sys.path.insertの働きを教えてくれる情報がありませんでした。
どなたかご存じの方がいたら、ご教示の程、よろしくお願いいたします。

Answer 1

まずsys.pathについて。

モジュールを検索するパスを示す文字列のリスト。

sys --- システムパラメータと関数 — Python 3.8.2 ドキュメント

リストということなので、listのメソッドを探すために組み込み型のページを見に行きます。「ミュータブルなシーケンス型」のところにあります。

s.insert(i, x)

s の i で与えられたインデックスに x を挿入します。
組み込み型 — Python 3.8.2 ドキュメント

---

import sys
folder_path = "C:\Users\document\my_code\"
sys.path.insert(0, folder_path)

モジュール検索パスのリストの先頭に、自分のコードの在り処を突っ込んでいることになります。

まず、my_codeの中に置いたパッケージはこのコード自体の在り処に関係なくimportできるようになります（別にmy_codeフォルダの中にこのコードがなくてもいいし、カレントディレクトリとかもどこでもいい）。

あとはこのパスは先頭から優先的に見られますので、他のライブラリ等と名前が被る自作パッケージがあると、自作の方が優先的にimportされます。まあ、他のライブラリと名前が被る事態は通常避けるべきなのですが。