Flask SQLAlchemy

Flask
Flask, SQLAlchemy

参考

シェルで動作確認

Dockerコンテナのビルド

Flask on Dockerのブログ と同様にDockerfileを作り、ビルドする。

ファイルを作成

1
2
3
4
5
6
7
8
9
10
$ mkdir -p  ~/Sources/docker_flask/sqlalchemy
$ cd ~/Sources/docker_flask/sqlalchemy
$ cat << EOF > Dockerfile
  FROM ubuntu:latest
  
  RUN apt-get update
  RUN apt-get install python3 python3-pip -y
  
  RUN pip3 install flask flask_sqlalchemy
  EOF

ビルド

1
$ sudo docker build . -t dobachi/flask_sqlalchemy:1.0

アプリ作成と実行

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask
  from flask_sqlalchemy import SQLAlchemy
  
  app = Flask(__name__)
  app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
  db = SQLAlchemy(app)

  class User(db.Model):
      id = db.Column(db.Integer, primary_key=True)
      username = db.Column(db.String(80), unique=True, nullable=False)
      email = db.Column(db.String(120), unique=True, nullable=False)
  
      def __repr__(self):
          return '<User %r>' % self.username
  EOF

シェルを起動する。

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask_sqlalchemy:1.0 /bin/bash

シェル内で動作確認。テーブルを作ってレコードを生成。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
>>> from app import db
/usr/local/lib/python3.6/dist-packages/flask_sqlalchemy/__init__.py:794: FSADeprecationWarning: SQLALCHEMY_TRACK_MODIFICATIONS adds significant overhead and will be disabled by default in the future.  Set it to True or False to suppress this warning.
  'SQLALCHEMY_TRACK_MODIFICATIONS adds significant overhead and '
>>> db.create_all()
>>> from app import User
>>> admin = User(username='admin', email='admin@example.com')
>>> guest = User(username='guest', email='guest@example.com')
>>> db.session.add(admin)
>>> db.session.add(guest)
>>> db.session.commit()
>>> User.query.all()
[<User 'admin'>, <User 'guest'>]
>>> User.query.filter_by(username='admin').first()
<User 'admin'>

sqlite3コマンドで接続して内容を確認。

1
2
3
4
5
6
7
8
9
root@a5d5ee81df78:/usr/local/apps# apt install sqlite3
root@a5d5ee81df78:/usr/local/apps# sqlite3 /tmp/test.db
sqlite> .databases
main: /tmp/test.db
sqlite> .tables
user
sqlite> select * from user;
1|admin|admin@example.com
2|guest|guest@example.com

アプリから動作確認

上記と同様の流れをアプリから動作確認する。 Dockerイメージは上記で作ったものをベースとする。

アプリ作成

ここでは/registにアクセスすると、登録画面が出て、 登録するとリスト（/list）が表示されるアプリを作成する。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
$ mkdir -p  ~/Sources/docker_flask/sqlalchemy_app
$ cd ~/Sources/docker_flask/sqlalchemy_app
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, url_for, request, render_template, redirect
  from flask_sqlalchemy import SQLAlchemy
  
  app = Flask(__name__)
  app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////tmp/test.db'
  db = SQLAlchemy(app)
  
  class User(db.Model):
      id = db.Column(db.Integer, primary_key=True)
      username = db.Column(db.String(80), unique=True, nullable=False)
      email = db.Column(db.String(120), unique=True, nullable=False)
  
      def __repr__(self):
          return '<User %r>' % self.username
  
  db.create_all()
  
  @app.route('/regist', methods=['POST', 'GET'])
  def regist():
      if request.method == 'POST':
          user = User(username=request.form['username'], email=request.form['email'])
          db.session.add(user)
          db.session.commit()
          return redirect(url_for('list'))
      # the code below is executed if the request method
      # was GET or the credentials were invalid
      return render_template('regist.html')
  
  @app.route('/list')
  def list():
      users = User.query.order_by(User.username).all()
      return render_template('list.html', users=users)
  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/regist.html
  <!doctype html>
  <title>Registration</title>
  <form action="/regist" method="post">
    <div>username: <input type="text" name="username"></div>
    <div>email: <input type="text" name="email"></div>
    <input type="submit" value="send">
    <input type="reset" value="reset">
  </form>
  
  <a href="/list">list</a>
  EOF
$ cat << EOF > apps/templates/list.html
  <!doctype html>
  <title>List ordered by username</title>
  <table>
      <thead>
          <tr>
              <th>id</th>
              <th>username</th>
              <th>email</th>
          </tr>
        </thead>
      <tbody>
          {% for item in users %}
          <tr>
              <td>
                  {{ item.id }}
              </td>
              <td>
                  {{ item.username }}
              </td>
              <td>
                  {{ item.email }}
              </td>
          </tr>
          {% endfor %}
      </tbody>
  </table>
  <a href="/regist">registration</a>
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask_sqlalchemy:1.0 flask run --host 0.0.0.0

なお、上記の実装はエラーハンドリング等を一切実施していないので 例えば同じユーザ名、メールアドレスで登録しようとすると例外が生じる。

共有

tmux_rectangle_select

Toolstmux
tmux

参考

方法

tmuxを使ってコピーするとき、矩形選択したいときがある。 矩形選択にも言及のあるブログ にも記載あるが、 <prefix> + [ でコピーモードに入った後、 該当箇所まで移動し、スペースキーを押して選択開始、その後 v を押すと矩形選択になる。 （初期状態では、行選択になっているはず）

共有

Gitのgitignore

ToolsGit
Git

参考

手順

後からまとめてignoreする方法 の通りで問題ない。

gitignoreファイルのダウンロード

GitHubのgitignoreファイルの雛形 からダウンロード。

Pythonの例

1
2
$ cd <レポジトリ>
$ wget https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore

必要に応じて既存の.gitignoreとマージしたり、mvして.gitignoreとしたり。

1
$ mv Python.gitignore .gitignore

コミット。

1
2
$ git add .gitignore
$ git commit -m "Add ignore pattern"

すでにコミットしてしまったファイルがあればまとめて削除。

1
$ git rm --cached `git ls-files --full-name -i --exclude-from=.gitignore`
共有

Flask extension

Flask
Docker, Dockerfile, Flask

参考

flask_adminを試す

flask-adminのドキュメント を見ながら進める。 またFlask on Dockerのブログ で作成したDockerイメージを使って環境を作る。

Dockerfileを作成してビルド

1
2
3
4
5
6
7
8
9
10
$ mkdir -p  ~/Sources/docker_flask/docker_admin
$ cd ~/Sources/docker_flask/docker_admin
$ cat << EOF > Dockerfile
  FROM ubuntu:latest
  
  RUN apt-get update
  RUN apt-get install python3 python3-pip -y
  
  RUN pip3 install flask flask_admin
  EOF
1
$ sudo docker build . -t dobachi/flask_admin:1.0

アプリ作成と実行

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask
  from flask_admin import Admin
  
  app = Flask(__name__)
  
  # set optional bootswatch theme
  app.config['FLASK_ADMIN_SWATCH'] = 'cerulean'
  
  admin = Admin(app, name='microblog', template_mode='bootstrap3')
  
  @app.route('/')
  def index():
      return "Hello world!!"
  EOF
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask_admin:1.0 flask run --host 0.0.0.0
共有

Check global IP address

Home serverNetwork
Network

参考

手順

1
$ curl globalip.me
共有

Flask on Docker

Flask
Docker, Dockerfile, Flask

参考

自前のイメージを作って動かす手順

基本的には Flask込みのDockerイメージを作る方法のブログ で記載された内容で問題ない。 自身の環境向けにアレンジは必要。

Dockerfileとビルド

Dockerfileは Flask込みのDockerイメージを作る方法のブログ の通り。

1
2
3
4
5
6
7
8
9
10
$ mkdir -p  ~/Sources/docker_flask/simple
$ cd ~/Sources/docker_flask/simple
$ cat << EOF > Dockerfile
  FROM ubuntu:latest
  
  RUN apt-get update
  RUN apt-get install python3 python3-pip -y
  
  RUN pip3 install flask
  EOF

ビルドコマンドは自分の環境に合わせた。

1
$ sudo docker build . -t dobachi/flask:1.0

インタラクティブにつなげる例も自分の環境に合わせた。

1
$ docker run -it --rm dobachi/flask:1.0 /bin/bash

アプリ作成と実行

自分の環境に合わせた。 Flask込みのDockerイメージを作る方法のブログ では、 /bin/bashを起動してから、python3 <アプリ >としていたが、 ここでは直接指定して実行することにした。

1
2
3
4
5
6
7
8
9
10
11
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask
  
  app = Flask(__name__)
  
  @app.route('/')
  def index():
      return "Hello world!!"
  EOF
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

なお、もともとの Flask込みのDockerイメージを作る方法のブログ では、以下のようにPythonコマンドから直接実行するように記載されていたが、 今回は Flask公式 に従い、FlaskのCLIを用いることとした。

1
sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps dobachi/flask:1.0 python3 /usr/local/apps/app.py

その際、手元の環境ではLANG等の事情により、いくつか環境変数を設定しないとエラーを吐いたので、 上記のようなコマンドになった。

公式手順に則ったシンプルな例

上記で作ったDockerイメージを流用する。

準備

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
$ mkdir -p  ~/Sources/docker_flask/getting_started
$ cd ~/Sources/docker_flask/getting_started
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, url_for, request, render_template

  app = Flask(__name__)
  
  @app.route('/')
  def index():
      return 'index'

  @app.route('/user/<username>')
  def profile(username):
      return '{}\'s profile'.format(username)
  
  @app.route('/post/<int:post_id>')
  def post(post_id):
      # show the post with the given id, the id is an integer
      return 'Post %d' % post_id
  
  @app.route('/path/<path:subpath>')
  def subpath(subpath):
      # show the subpath after /path/
      return 'Subpath %s' % subpath
  
  @app.route('/projects/')
  def projects():
      return 'The project page'
  
  @app.route('/about')
  def about():
      return 'The about page'

  @app.route('/login', methods=['GET', 'POST'])
  def login():
      if request.method == 'POST':
          return do_the_login()
      else:
          return show_the_login_form()

  def do_the_login():
    return 'Do log in'

  def show_the_login_form():
    return 'This is a login form'

  @app.route('/hello/')
  @app.route('/hello/<name>')
  def hello(name=None):
      return render_template('hello.html', name=name)

  # Test for URLs
  with app.test_request_context():
      print(url_for('index'))
      print(url_for('login'))
      print(url_for('login', next='/'))
      print(url_for('profile', username='John Doe'))
  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/hello.html
  <!doctype html>
  <title>Hello from Flask</title>
  {% if name %}
    <h1>Hello {{ name }}!</h1>
  {% else %}
    <h1>Hello, World!</h1>
  {% endif %}
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

フォームを使う例

上記で作ったDockerイメージを流用する。

準備

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
$ mkdir -p  ~/Sources/docker_flask/form
$ cd ~/Sources/docker_flask/form
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, url_for, request, render_template, redirect, session

  app = Flask(__name__)

  # Set the secret key to some random bytes. Keep this really secret!
  app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'
  
  @app.route('/login', methods=['POST', 'GET'])
  def login():
      error = None
      if request.method == 'POST':
          if valid_login(request.form['username'],
                         request.form['password']):
              session['username'] = request.form['username']
              return redirect(url_for('welcome'))
          else:
              error = 'Invalid username/password'
      # the code below is executed if the request method
      # was GET or the credentials were invalid
      return render_template('login.html', error=error)

  @app.route('/welcome')
  def welcome():
    if 'username' in session:
      return render_template('welcome.html', username=session['username'])
    else:
      return redirect(url_for('login'))

  def valid_login(username, password):
    if username == 'hoge' and password == 'fuga':
      return True
    else:
      return False
  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/welcome.html
  <!doctype html>
  <title>Hello from Flask</title>
  <h1>Hello {{ username }}!</h1>
  EOF
$ cat << EOF > apps/templates/login.html
  <!doctype html>
  <title>Question from Flask</title>
  {% if error %}
    <h1>Please use valid username and password</h1>
  {% endif %}
  <form action="/login" method="post">
    <div>username: <input type="text" name="username"></div>
    <div>password: <input type="password" name="password"></div>
    <input type="submit" value="Send">
    <input type="reset" value="Reset">
  </form>
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

ファイルのアップロード

上記で作ったDockerイメージを流用する。

準備

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
$ mkdir -p  ~/Sources/docker_flask/file_upload
$ cd ~/Sources/docker_flask/file_upload
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, request, render_template, redirect, session, url_for
  from werkzeug.utils import secure_filename

  app = Flask(__name__)
  
  # Set the secret key to some random bytes. Keep this really secret!
  app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'

  @app.route('/upload', methods=['GET', 'POST'])
  def upload_file():
      if request.method == 'POST':
          f = request.files['the_file']
          session['filename'] = secure_filename(f.filename)
          f.save('/tmp/' + session['filename'])
          return redirect(url_for('done'))
      elif request.method == 'GET':
          return render_template('upload.html')

  @app.route('/done')
  def done():
      return render_template('done.html')

  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/upload.html
  <!doctype html>
  <title>Fileuploader by Flask</title>
  <form action="/upload" method="post" enctype="multipart/form-data">
    <div>file: <input type="file" name="the_file"></div>
    <input type="submit" value="Send">
    <input type="reset" value="Reset">
  </form>
  EOF
$ cat << EOF > apps/templates/done.html
  <!doctype html>
  <title>Fileuploader by Flask</title>
  <h1>The file: {{ filename }} was uploaded</h1>
  <a href="/upload">Got to the first page</a>
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

クッキー

上記で作ったDockerイメージを流用する。

準備

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
$ mkdir -p  ~/Sources/docker_flask/cookie
$ cd ~/Sources/docker_flask/cookie
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, url_for, request, render_template, redirect, make_response

  app = Flask(__name__)

  # Set the secret key to some random bytes. Keep this really secret!
  app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'
  
  @app.route('/login', methods=['POST', 'GET'])
  def login():
      error = None
      if request.method == 'POST':
          if valid_login(request.form['username'],
                         request.form['password']):
              username = request.form['username']
              resp = make_response(render_template('success.html'))
              resp.set_cookie('username', username)
              return resp
          else:
              error = 'Invalid username/password'
      elif request.method == 'GET':
          if 'username' in request.cookies:
              return redirect(url_for('welcome'))
          else:
              return render_template('login.html', error=error)

  @app.route('/logout')
  def logout():
      resp = make_response(render_template('logout.html'))
      resp.delete_cookie('username')
      return resp

  @app.route('/welcome')
  def welcome():
    if 'username' in request.cookies:
      return render_template('welcome.html', username=request.cookies.get('username'))
    else:
      return redirect(url_for('login'))

  def valid_login(username, password):
    if username == 'hoge' and password == 'fuga':
      return True
    else:
      return False
  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/welcome.html
  <!doctype html>
  <title>Hello from Flask</title>
  <h1>Hello {{ username }}!</h1>
  <a href="/logout">logout</a>
  EOF
$ cat << EOF > apps/templates/success.html
  <!doctype html>
  <title>Login Success</title>
  <h1>Login!</h1>
  <META http-equiv="Refresh" content="3;URL=/welcome">
  <p>Jump in 3 seconds</p>
  EOF
$ cat << EOF > apps/templates/logout.html
  <!doctype html>
  <title>Logout Success</title>
  <h1>Logout!</h1>
  <META http-equiv="Refresh" content="3;URL=/login">
  <p>Jump in 3 seconds</p>
  EOF
$ cat << EOF > apps/templates/login.html
  <!doctype html>
  <title>Question from Flask</title>
  {% if error %}
    <h1>Please use valid username and password</h1>
  {% endif %}
  <form action="/login" method="post">
    <div>username: <input type="text" name="username"></div>
    <div>password: <input type="password" name="password"></div>
    <input type="submit" value="Send">
    <input type="reset" value="Reset">
  </form>
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

ロギング

上記で作ったDockerイメージを流用する。

準備

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
$ mkdir -p  ~/Sources/docker_flask/logging
$ cd ~/Sources/docker_flask/logging
$ mkdir apps
$ cat << EOF > apps/app.py
  from flask import Flask, url_for, request, render_template, redirect, session

  app = Flask(__name__)

  # Set the secret key to some random bytes. Keep this really secret!
  app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'
  
  @app.route('/login', methods=['POST', 'GET'])
  def login():
      error = None
      if request.method == 'POST':
          if valid_login(request.form['username'],
                         request.form['password']):
              session['username'] = request.form['username']
              return redirect(url_for('welcome'))
          else:
              app.logger.warning('Failed to login as:' + request.form['username'])
              error = 'Invalid username/password'
      # the code below is executed if the request method
      # was GET or the credentials were invalid
      return render_template('login.html', error=error)
  
  @app.route('/welcome')
  def welcome():
    if 'username' in session:
      return render_template('welcome.html', username=session['username'])
    else:
      return redirect(url_for('login'))
  
  def valid_login(username, password):
    if username == 'hoge' and password == 'fuga':
      return True
    else:
      return False
  EOF
$ mkdir -p apps/templates
$ cat << EOF > apps/templates/welcome.html
  <!doctype html>
  <title>Hello from Flask</title>
  <h1>Hello {{ username }}!</h1>
  EOF
$ cat << EOF > apps/templates/login.html
  <!doctype html>
  <title>Question from Flask</title>
  {% if error %}
    <h1>Please use valid username and password</h1>
  {% endif %}
  <form action="/login" method="post">
    <div>username: <input type="text" name="username"></div>
    <div>password: <input type="password" name="password"></div>
    <input type="submit" value="Send">
    <input type="reset" value="Reset">
  </form>
  EOF

実行

1
$ sudo docker run -it --rm -p 5000:5000 -v $(pwd)/apps:/usr/local/apps -e "FLASK_APP=app.py" -w /usr/local/apps -e "LC_ALL=C.UTF-8" -e "LANG=UTF-8" dobachi/flask:1.0 flask run --host 0.0.0.0

JSON形式でやり取りする例

基本的には、 DockerコンテナでFlaskを起動し, JSONデータのPOSTとGET の通り。

Dockerfile

dockerfileを作る。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
$ mkdir -p  ~/Sources/docker_flask/post_json
$ cd ~/Sources/docker_flask/post_json
$ cat << EOF > Dockerfile
  fROM python:3.6
  
  aRG project_dir=/app/
  
  # ADD requirements.txt \$project_dir
  aDD reply.py \$project_dir
  
  wORKDIR \$project_dir
  
  rUN pip install flask
  # RUN pip install -r requirements.txt
  
  cMD ["python", "reply.py"]
  eOF

アプリ

アプリを作る。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
$ cat << EOF > reply.py
  from flask import Flask, jsonify, request
  import json
  app = Flask(__name__)
  
  @app.route("/", methods=['GET'])
  def hello():
      return "Hello World!"
  
  @app.route('/reply', methods=['POST'])
  def reply():
      data = json.loads(request.data)
      answer = "Yes, it is %s!\n" % data["keyword"]
      result = {
        "Content-Type": "application/json",
        "Answer":{"Text": answer}
      }
      # return answer
      return jsonify(result)
  
  if __name__ == "__main__":
      app.run(host='0.0.0.0',port=5000,debug=True)
  eOF

ビルドする。

1
$ sudo docker build . -t dobachi/flask_json:1.0

動作確認

ポート5000で起動する。

1
$ sudo docker run --rm -p 5000:5000 -it dobachi/flaskjson:1.0

動作確認する。

1
$ curl http://localhost:5000/reply -X POST -H "Content-Type: application/json" -d '{"keyword": "Keffia"}'

nginxと組み合わせて動かす

gitHub: uwsgi-nginx-flask-docker を参考にする。 gitHub: uwsgi-nginx-flask-dockerのクイックスタート を見ながら試す。

Dockerfile、アプリなど

1
2
$ mkdir -p  ~/Sources/docker_flask/nginx
$ cd ~/Sources/docker_flask/nginx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$ cat << EOF > Dockerfile
  fROM tiangolo/uwsgi-nginx-flask:python3.7
  
  cOPY ./app /app
  eOF
$ mkdir app
$ cat << EOF > app/main.py
  from flask import Flask
  app = Flask(__name__)
  
  @app.route("/")
  def hello():
      return "Hello World from Flask"
  
  if __name__ == "__main__":
      # Only for debugging while developing
      app.run(host='0.0.0.0', debug=True, port=80)
  eOF

ビルド

1
$ sudo docker build -t dobachi/nginx-flask:1.0 .

実行

1
$ sudo docker run --rm -it -p 8080:80 dobachi/nginx-flask:1.0

nginxと組あわせてSPA

gitHub: uwsgi-nginx-flask-dockerのSPA を参考に進める。

Dockerfileとアプリ

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
$ mkdir -p  ~/Sources/docker_flask/nginx_spa
$ cd ~/Sources/docker_flask/nginx_spa
$ cat << EOF > Dockerfile
  fROM tiangolo/uwsgi-nginx-flask:python3.7
  
  eNV STATIC_INDEX 1
  
  cOPY ./app /app
  eOF
$ mkdir app
$ cat << EOF > app/main.py
  import os
  from flask import Flask, send_file
  app = Flask(__name__)
  
  
  @app.route("/hello")
  def hello():
      return "Hello World from Flask"
  
  
  @app.route("/")
  def main():
      index_path = os.path.join(app.static_folder, 'index.html')
      return send_file(index_path)
  
  
  # Everything not declared before (not a Flask route / API endpoint)...
  @app.route('/<path:path>')
  def route_frontend(path):
      # ...could be a static file needed by the front end that
      # doesn't use the `static` path (like in `<script src="bundle.js">`)
      file_path = os.path.join(app.static_folder, path)
      if os.path.isfile(file_path):
          return send_file(file_path)
      # ...or should be handled by the SPA's "router" in front end
      else:
          index_path = os.path.join(app.static_folder, 'index.html')
          return send_file(index_path)
  
  
  if __name__ == "__main__":
      # Only for debugging while developing
      app.run(host='0.0.0.0', debug=True, port=80)
  eOF
1
2
3
4
5
6
7
8
9
10
11
12
13
$ mkdir app/static
$ cat << EOF > app/static/index.html
  <!DOCTYPE html>
  <html lang="en">
  <head>
      <meta charset="UTF-8">
      <title>Index</title>
  </head>
  <body>
  <h1>Hello World from HTML</h1>
  </body>
  </html>
  eOF

ビルド

1
$ sudo docker build -t dobachi/nginx-flask-spa:1.0 .

実行

1
$ sudo docker run --rm -it -p 8080:80 dobachi/nginx-flask-spa:1.0

構造的なプロジェクト

gitHub: 構造的なプロジェクトの例 に記載の例を示す。 example-flask-package-python3.7.zip をダウンロードしてビルドしてみる。

アーカイブをダウンロード

1
2
3
4
$ mkdir -p  ~/Sources/docker_flask/
$ wget https://github.com/tiangolo/uwsgi-nginx-flask-docker/releases/download/v0.3.10/example-flask-package-python3.7.zip
$ unzip example-flask-package-python3.7.zip
$ cd example-flask-package-python3.7

ビルド

1
$ sudo docker build -t dobachi/nginx-flask-package:1.0 .

実行

1
$ sudo docker run --rm -it -p 8080:80 dobachi/nginx-flask-package:1.0

一部修正してみる

apiを追加する。

ファイルを修正 

1
2
3
$ cat example-flask-package-python3.7/app/app/api/api.py 
from .endpoints import user
from .endpoints import get_ip

ファイルを追加 

1
2
3
4
5
6
7
8
9
10
11
$ cat example-flask-package-python3.7/app/app/api/endpoints/get_ip.py 
from flask import request
from flask import jsonify

from ..utils import senseless_print

from ...main import app

@app.route("/get_ip", methods=["GET"])
def get_ip():
        return jsonify({'ip': request.remote_addr}), 200

ビルドし、実行して、/get_ipにアクセスすると、接続元のIPアドレスが表示される。

flask + NginxでSSLを使用（ここがうまく動かない）

アドホックな対応

flask + NginxでのSSL対応に関する記事 に記載された方法で試す。 また上記で使ったexample-flask-package-python3.7の例を用いてみる。

まずDockerfileを以下のように変更した。

1
2
3
4
5
6
7
$ cat Dockerfile 
froM tiangolo/uwsgi-nginx-flask:python3.7

run apt-get update
run pip install pyopenssl

copY ./app /app

main.pyを以下のように修正し、アドホックなSSL対応を試せるようにする。

1
2
3
4
5
6
7
8
9
10
11
12
$ cat app/app/main.py 
from flask import Flask

app = Flask(__name__)

from .core import app_setup


if __name__ == "__main__":
    # Only for debugging while developing
    # app.run(host='0.0.0.0', debug=True, port=80)
    app.run(host='0.0.0.0', debug=True, ssl_context='adhoc')

以上の修正を加えた上で、Dockerイメージをビルドし実行した。

1
2
$ sudo docker build -t dobachi/nginx-flask-package:1.0 .
$ sudo docker run --rm -it -p 8080:80 dobachi/nginx-flask-package:1.0  /bin/bash

gitHub: uwsgi-nginx-flask-dockerのアーキテクチャ

gitHub: uwsgi-nginx-flask-dockerのテクニカル詳細 で書かれている通り。 以下の役割分担。

  • ウェブサーバ：Nginx
  • wSGIのアプリサーバ：uWSGI

またアプリはFlaskで書かれていることを前提とし、 プロセスはSupervisordで管理される。 アプリはコンテナ内の/app以下に配備されることを前提とし、その中にとりあえずは動くuwsgi.iniも含まれる。 そのため、Dockerfile内でuwsgi.iniを上書きさせるようにして用いることを想定しているようだ。

Supervisord化について

以下のように/bin/bashを起動して確認した。

1
$ sudo docker run --rm -it -p 8080:80 dobachi/nginx-flask-package:1.0  /bin/bash

/etc/supervisor/conf.d/supervisord.confを確認する。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# cat /etc/supervisor/conf.d/supervisord.conf 
[supervisord]
nodaemon=true

[program:uwsgi]
command=/usr/local/bin/uwsgi --ini /etc/uwsgi/uwsgi.ini --die-on-term --need-app
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0

[program:nginx]
command=/usr/sbin/nginx
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0
# graceful stop, see http://nginx.org/en/docs/control.html
stopsignal=QUIT

uwsgiとnginxを起動させていることがわかる。

続いて、nginxの設定において、uwsgiと連携しているのを設定している箇所を確認。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# cat /etc/nginx/conf.d/nginx.conf 
server {
    listen 80;
    location / {
        try_files $uri @app;
    }
    location @app {
        include uwsgi_params;
        uwsgi_pass unix:///tmp/uwsgi.sock;
    }
    location /static {
        alias /app/static;
    }
}

uwsgiでは、/appディレクトリ以下のuwsgi.iniと/etc/uwsgi/uwsgi.iniの両方を確認するようだ。

1
2
3
4
5
6
7
# cat /etc/uwsgi/uwsgi.ini 
[uwsgi]
socket = /tmp/uwsgi.sock
chown-socket = nginx:nginx
chmod-socket = 664
# graceful shutdown on SIGTERM, see https://github.com/unbit/uwsgi/issues/849#issuecomment-118869386
hook-master-start = unix_signal:15 gracefully_kill_them_all
1
2
3
4
# cat /app/uwsgi.ini 
[uwsgi]
module = app.main
callable = app
共有

PixieDustを試してみる

ResearchData AnalyticsTools
Data Analytics, Jupyter, Python, Tools

参考

公式サイトの確認

ここでは気になったことを記しておく。

Scalaでも使える？

公式GitHubのREADMEには、 Use in python or scala という項目があり、 そこには以下のような記述がある。

1
PixieDust lets you bring robust Python visualization options to your Scala notebooks.
1
Scala Bridge. Use Scala directly in your Python notebook. Variables are automatically transfered from Python to Scala and vice-versa. Learn more.
1
Spark progress monitor. Track the status of your Spark job. No more waiting in the dark. Notebook users can now see how a cell's code is running behind the scenes.

Jupyterに独自のカーネルをインストールして使う

カーネルを追加することで、ユーザが自身の環境に依存するライブラリ（Sparkなど）をインストールしなくても 簡単に使えるようになっているようだ？ ★要確認

動作確認

まずは、公式ウェブサイトのインストール手順 を読みつつ、 Qiitaの紹介ブログ を読みながら、軽く試してみることにした。 Anacondaを使っているものとし、Condaで環境を作る。

1
2
$ conda create -n PixieDustExample python=3.5 jupyter
$ conda activate PixieDustExample

また 公式ウェブサイトのインストール手順 には、以下のような記述があり、 Pythonは2.7もしくは3.5が良いようだ。

1
Note PixieDust supports both Python 2.7 and Python 3.5.

pipでpixiedustを探すと、エコシステムが形成されているようだった。

1
2
3
4
5
6
7
8
9
10
$ pip search pixiedust
pixiedust-node (0.2.5)                    - Pixiedust extension for Node.js
pixiedust-flightpredict (0.12)            - Flight delay predictor application with PixieDust
pixiedust-wordcloud (0.2.2)               - Word Cloud Visualization Plugin for PixieDust
pixiedust-twitterdemo1 (0.1)              - Pixiedust demo of the Twitter Sentiment Analysis tutorials
pixiedust-twitterdemo (0.4)               - Pixiedust demo of the Twitter Sentiment Analysis tutorials
pixiedust (1.1.14)                        - Productivity library for Jupyter Notebook
pixiedust-optimus (1.4.0)                 - Productivity library for Spark Python Notebook
pixiegateway (0.8)                        - Server for sharing PixieDust chart and running PixieApps
stem-ladiespixiedust-twitterdemo (0.2.2)  - Pixiedust demo of the Twitter Sentiment Analysis tutorialsfor the STEM activity wall

そのまま入れることとする。依存関係でいくつかライブラリが入る。

1
$ pip install pixiedust

エラー。

1
twisted 18.7.0 requires PyHamcrest>=1.9.0, which is not installed.

condaでインストールする。

1
$ conda install PyHamcrest

PixieDust向けのJupyterカーネルをインストールする。 なお、本手順の前に、JDKがインストールされ、JAVA_HOMEがインストールされていることを前提とする。

1
$ jupyter pixiedust install

エラー。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
$ jupyter pixiedust install
Step 1: PIXIEDUST_HOME: /home/dobachi/pixiedust
        Keep y/n [y]? y
Step 2: SPARK_HOME: /home/dobachi/pixiedust/bin/spark
        Keep y/n [y]? y
Directory /home/dobachi/pixiedust/bin/spark does not contain a valid SPARK install
        Download Spark y/n [y]? y
What version would you like to download? 1.6.3, 2.0.2, 2.1.0, 2.2.0, 2.3.0 [2.3.0]: 
SPARK_HOME will be set to /home/dobachi/pixiedust/bin/spark/spark-2.3.0-bin-hadoop2.7
Downloading Spark 2.3.0
Traceback (most recent call last):

(snip)

  File "/home/dobachi/.conda/envs/PixieDustExample/lib/python3.7/site-packages/install/createKernel.py", line 408, in download_spark
    temp_file = self.download_file(spark_download_url)
  File "/home/dobachi/.conda/envs/PixieDustExample/lib/python3.7/site-packages/install/createKernel.py", line 455, in download_file
    raise Exception("{}".format(response.status_code))
Exception: 404

Sparkのダウンロードで失敗しているようだ。 軽くデバッグしたところ、URLとして渡されているのは、 http://apache.claz.org/spark/spark-2.3.0/spark-2.3.0-bin-hadoop2.7.tgzのようだった。 確かに、リンク切れ？のようだった。いったん、Spark公式サイトのダウンロードページで 指定されるURLからダウンロードするよう、createKernel.pyを修正して実行することにした。

なお、上記手順により、指定したディレクトリにSparkとScalaがインストールされる。 成功すると、以下のようなメッセージが見られる。

1
2
3
4
5
6
7
(snip)

####################################################################################################
#       Congratulations: Kernel Python-with-Pixiedust_Spark-2.3 was successfully created in /home/dobachi/.local/share/jupyter/kernels/pythonwithpixiedustspark23
#       You can start the Notebook server with the following command:
#               jupyter notebook /home/dobachi/pixiedust/notebooks
####################################################################################################

なお、そのまま実行したら、以下のライブラリが足りないと言われたので予めインストールすることとする。 （bokeh、seabornはついでにインストール。インストールしないとRendererの選択肢が出てこない）

1
$ conda install matplotlib pandas PyYaml bokeh seaborn

さて、 Qiitaの紹介ブログ では、PixieDustのカーネルインストール時に一緒にインストールされるノートブックではなく、 日本語でわかりやすい紹介記事が書かれているが、ここではいったん、上記のインストール時のメッセージに従うこととする。

Jupyterを起動

1
$ jupyter notebook /home/dobachi/pixiedust/notebooks

あとは、適当にノートブックを眺めて実行する。

PixieDust 1 - Easy Visualizationsで気になったこと

Loading External Data節でD3 Rendererを試したところ、以下のようなエラー。

1
Object of type ndarray is not JSON serializable
共有

Adobe reader on Ubuntu18

Home serverUbuntuAdobe Reader
Adobe Reader, PDF

参考

手順

Adobe Readerのインストール手順を記したブログ に記載の手順で基本的には問題ない。

1
2
3
4
$ sudo apt install libxml2:i386 gdebi-core 
$ cd ~/Downloads
$ wget ftp://ftp.adobe.com/pub/adobe/reader/unix/9.x/9.5.5/enu/AdbeRdr9.5.5-1_i386linux_enu.deb
$ sudo gdebi AdbeRdr9.5.5-1_i386linux_enu.deb

ファイラから開くときのデフォルトアプリの設定の参考にした情報 を参考に設定する。

1
$ sudo vim /etc/gnome/defaults.list

変更内容は以下の通り。

1
2
3
4
5
6
7
8
9
10
11
--- /etc/gnome/defaults.list.2018121101	2018-12-11 22:42:03.566334756 +0900
+++ /etc/gnome/defaults.list	2018-12-11 22:42:15.970075520 +0900
@@ -5,7 +5,7 @@
 application/msword=libreoffice-writer.desktop
 application/ogg=rhythmbox.desktop
 application/oxps=evince.desktop
-application/pdf=evince.desktop
+application/pdf=acroread.desktop
 application/postscript=evince.desktop
 application/rtf=libreoffice-writer.desktop
 application/tab-separated-values=libreoffice-calc.desktop
共有

onedrive for linux

Home serverUbuntuOneDrive
OneDrive

参考

手順

インストール 

1
2
3
4
5
6
7
8
9
$ sudo apt install libcurl4-openssl-dev libsqlite3-dev
$ curl -fsS https://dlang.org/install.sh | bash -s dmd
$ source ~/dlang/dmd-2.083.1/activate
$ cd ~/Sources
$ git clone https://github.com/abraunegg/onedrive.git
$ cd onedrive
$ source ~/dlang/dmd-2.083.1/activate
$ make
$ sudo make install

一部同期の設定 

1
2
$ mkdir -p ~/.config/onedrive
$ vim ~/.config/onedrive/sync_list  # 中にディレクトリを並べる

（再）同期 

1
$ onedrive --synchronize --resync

その後、初回同期時はウェブ認証が走るので従う。 白い画面がブラウザで現れたら、そのURLをコピーしてコンソールにペーストし、実行する。

アンインストール 

1
$ sudo make uninstall

共有

BlazeItの論文

ResearchVideo processingBlazeIt
BlazeIt, Machine Learning, Video Processing

参考

論文の概要

動画の活用への期待が高まっている？

動画のボリュームが増し、分析者が動画分析に興味を持っている。

  • 交通meter設定の計画、都市計画。
    • 車の行き交うのを観測し、台数を算出する
  • 自動車会社
    • ペデストリアンの感想？ ★要確認

これらを人手で確認するのは費用対効果が悪い。

既存手法としては、物体検知手法が挙げられる。

課題感

深層学習を使ったビジュアルデータの処理において、 GPUを使ったとしても高いfpsでの実時間処理が難しい。 state-of-artな物体検知手法Mask R-CNNですら、3fpsである。

またそれらの処理を実装するときには低レベルのライブラリ（例：OpenCV、Caffe2、Detectron）を使って 複雑な実装を施さないといけない。

なお、ビデオ処理の最適化の既存の研究はあるが、 それらは単一の機能を最適化するものである。 BlazeItは、Declarativeなクエリ言語を使って処理を記述し、さらに 最適化された処理のパイプラインを生成する。

BlazeItの構成

  • FrameQL
  • 最適化と実行エンジン
    • Aggregation
      • 物体検知を行うサンプリングレートを指定可能
      • 特化したNNを使う
      • control variateを使う ★要確認
    • Scrubbing
      • 稀に登場する物体を効率的に検知するため、 特化したNNのconfidence scoreを使う。
      • サンプリングにバイアスをかける
    • Selection
      • クエリの内容に応じていくつかのフィルタリングを組み合わせる
      • NoScopeラベルベース、コンテンツベース、スキップ（サブサンプリング）、 クロッピング

ユースケース

BlazeItは探索的なクエリに注力。 ★重要

  • aggregate: 車の数を数える、など
  • 探す: 動画の中で鳥が沢山飛んでいる瞬間を探す、など

特に動画が多く、全部に対して物体検知を行うのは非現実的なケースが適切。

ただし一部のデータに関しては、学習データとしてラベル付けされていることを前提とする。 ★重要

具体例:

  • 都市計画
    • 交通状況の観測と計画
    • 例えばバスX台、車Y台がいるタイミングを見つける、など
  • 自動運転
    • 黄色信号時の状況把握
    • 例えば黄色信号で通行者がX人いるタイミングを見つける、など
  • ストア計画
    • 店舗を区分けし、どの商品が人気なのか人の動向から把握する
  • 鳥類の研究者
    • 餌やりの状況把握

システム概要

設定

設定可能なコンポーネントは以下の通り。

  • 物体検知
  • フレーム跨りの物体検知
  • UDF

例えばフレーム跨りで物体を検知するときに、車のナンバープレートを使う、など 独自のロジックの差し込みが可能。

フィルタ

BlazeItのフィルタは確率的動作。 特化されたNNは、すべてのフレームにおいて精度が高いわけではない。 そこで、オプティマイザはエラーレートを参考にしつつプランを立てる。

特化NN

大きなNNの代わりに用いることができる単純化されたNN。 高速な計算が特徴。 既存研究ではバイナリ検知が主だったが、BlazeItの研究では カウントや多クラス分類に発展させた。

フィルタのブートストラップ

少量のラベル付け済みデータを用いる。

現時点での制約

  • モデルドリフト：動画の傾向が途中で変わる場合、モデルの再トレーニングが必要
  • ラベル付け済みデータセット：最初に特化NNをトレーニングするためのデータが必要
  • 物体検知が物体検知手法に依存：もし特別なことをさせたいならUDFを使用

FrameQL

ビデオを関係とみなし、selection、projection、aggregation（など関係に対するオペレーション）を可能とする。 テーブルのようなスキーマを提供することで、背景となる深層学習等の技術の専門家である必要なく、SQLが分かれば処理を記述可能とする。 また物体検知やフレーム間でのトラッキングロジックは、ユーザが独自のものを指定可能。 BlazeItはそれに応じて、スキーマを選択する。

シンタックスシュガーがあるが、それはBlinkDBと同じようなもののようだ。 ※BlinkDB由来、ということでUCBの流れを改めて感じる…

FrameQLのスキーマ

  • timestamp: オブジェクトのタイムスタンプ
  • class: オブジェクトタイプ（車、バス、など）
  • mask: オブジェクトの場所を表すポリゴン
  • trackid: 時間をまたいでオブジェクトを追跡するID
  • content: ポリゴンの中のピクセル
  • features: 物体検知手法により出力された特徴

FCOUNT

フレーム内に現れるオブジェクトの出現割合から算出される出現率？

いくつかの例

論文上はいくつかのFrameQLの例が載っている。

クエリ実行の概要

BlazeItにはFrameQLに基づいて処理を実行する際に最適化が行われる。 例えば、物体検知は計算コストが高いので、できるだけ減らそうとする。

aggregation、scrubbing、content-based selectionに関する最適化。

aggregationの最適化

最適化の方向性は以下の3点

  • トラディショナルなAQP
  • 特化NNを用いて書き換え
  • 特化NNを用いたControl Variate

BlazeItは最初に最適化の種類を特定する。

まず学習データが十分にあるかどうか。もしなければAQPを用いる。 またアダプティブなサンプリング手法も用いる。（例: オンラインアグリゲーション、BlinkDB）

十分にデータがあれば特化NNを用いる。

サンプリングについて補足

所定の（詳しくは論文参照）サンプル数から始め、 所定の基準に達するまでサンプル数を増やしていく。

Control Variateについて補足

Control Variateについては、 Control Variateについての解説記事 などを参照。

Optimizing Scrubbing Queriesについての補足

分析者はレアなシーンこそ検索したくなるものだが、 そうするとすべてのフレームに対し、物体検知をしないといけない。（そしてそれは遅い）

「レアイベントシミュレーション」と特化NNを組み合わせる。

複数の対象（例：バスと車）を検知する特化NNを それぞれ 用いる。 もし「バス1台、車3台」のような条件の時にはアンドをとって用いる。

コンテントベースのSelection

フィルタを使って検知処理を動かす前にフィルタする。 ラベルベース、コンテントベース、テンポラル、スペーシャル。

BlazeItはクエリからどのフィルタを使うべきかを推測する。 またユーザの期待するフレーム数に応じて、サンプリングレートを変える。

実装

既存のプロダクトを活用して作られている箇所とスクラッチで実装した箇所があるようだ。

  • コントロールプレーンはPython
  • NNではないフィルタはC++
  • PyToarchを学習や評価に利用
  • 物体検知にはFGFAを利用
    • MXNet v1.2、Mask R-CNNを利用
  • ビデオはOpenCVで走査

その他調べておきたいこと

  • NoScope
  • 物体検知関係の研究（YOLOv2、MS-COCO、Mask R-CNN、…）
共有