自作パッケージを任意のディレクトリにあるNotebookで常にimportできるようにする

前提知識

• 基本的なdockerコマンド, docker-composeコマンドの使い方
• JupyterLabの使い方

試行環境とファイル構成

• M1 MacBook Pro
• macOS Monterey 12.3.1
• Docker Desktop 4.7.1 (for Mac)
• ファイル構成

.
├── Dockerfile
├── docker-compose.yml
├── work
│    ├── mypackage
│    │      ├── __init__.py
│    │      └── test_module.py
│    └── test.ipynb
├── init.sh
└── import_path.pth

手順

手順概要

1. Dockerfileを作成する
2. import_path.pthを作成する
3. init.shを作成する
4. docker-compose.ymlを作成する
5. コンテナをbuildする
6. work以下に自作packageを作成する
7. work以下のディレクトリで，自作パッケージを試しにimportしてみる

1. Dockerfileを作成する

まずは，Dockerfileを書いていきます．

FROM continuumio/anaconda3:latest

# 必要なパッケージを入れる.
RUN apt-get update && apt-get install -y --no-install-recommends \
    fonts-ipaexfont \
    bash-completion \
    vim

# Debianの設定
RUN apt-get -y install locales && \
    localedef -f UTF-8 -i ja_JP ja_JP.UTF-8
ENV LANG ja_JP.UTF-8
ENV LANGUAGE ja_JP:ja
ENV LC_ALL ja_JP.UTF-8
ENV TZ JST-9
ENV TERM xterm

COPY import_path.pth /opt/conda/lib/python3.9/site-packages/import_path.pth

RUN apt-get autoremove -y \
  && apt-get clean
WORKDIR /work

COPY init.sh /usr/bin
CMD ["/bin/bash", "/usr/bin/init.sh"]

• COPY import_path.pth /opt/conda/lib/python3.9/site-packages/import_path.pthでファイルシステムの中にimport_path.pthをコピーする^[1]

2. import_path.pthを作成する

次に，import_path.pthを書いていきます．

/work

• 今回はwork以下を対象にするので，/workと記載する^[2]

3. init.shを作成する

JupyterLabを起動するためのコマンドを記載するinit.shファイルを書いていきます．

#!/bin/bash

source /etc/bash_completion
jupyter lab --ip=0.0.0.0 --allow-root --LabApp.token=''

• jupyter lab --ip=0.0.0.0 --allow-root --LabApp.token=''でJupyterLabが立ち上がる

4. docker-compose.ymlを作成する

コンテナを立ち上げるのに必要なdocker-compose.ymlを書いていきます．

version: "3.8"
services:
  notebook:
    build:
      context: .
      dockerfile: Dockerfile
    container_name: "jupyterlab"
    ports:
      - 8888:8888
    restart: always
    volumes:
      - ./work:/work

5. コンテナをbuildする

Dockerコンテナをbuildできる環境もできたので，いよいよコンテナを立ち上げます．

• $ docker-compose up -d --build
• 立ち上がったら，ブラウザでlocalhost:8888にアクセスしてJupyterLabがうまく起動できているか確認する

6. work以下に自作packageを作成する

JupyterLabが立ち上がったので，work以下に自作packageを作ります．

• $ cd work
• $ mkdir mypackage
• mypackageの下に__init__.pyとtest_module.pyを作ります^[3]

from .test_module import *

import datetime as dt

TEST_TERM = "test"


def show_today():
    print(dt.date.today())


class Test:
  pass

• 実際にJupyterLab側からmypackageが作られていることを確認できます
  

7. work以下のディレクトリで，自作パッケージを試しにimportしてみる

それでは，いよいよtest.ipynbでmypackageをimportしてみます．

• import mypackageとimportした後に，定数，関数，クラスを呼び出せている事がわかります
  

参考

• 【Python】site-packagesのパスを確認する方法【pip install・pyenv】
• 【python】任意のライブラリをインポートするためパスを通そう！