在 Mac 上安裝 MongoDB community

官方文件說明 其實很清楚了，但還是筆記一下。

首先 Mac 的環境要有 homebrew。

追踪 mongodb 官方的 brew 版本資訊：

brew tap mongodb/brew

安裝 mongodb-community，目前的穩定版本為 4.2

brew install mongodb-community

安裝後的設定檔及資料檔案位置：

• 設定檔位置： /usr/local/etc/mongod.conf
• 日誌檔位置： /usr/local/var/log/mongodb
• 資料檔位置： /usr/local/var/mongodb

安裝好就可以啟動服務了：

brew services start mongodb-community

停止服務：

brew services stop mongodb-community

Python 的安裝套件記錄

在 Python 的 venv 專案環境，可以使用 pip freeze 顯示安裝的套件。也常使用下式，將安裝的套件記錄在文字檔：

pip freeze > requirements.txt

文字檔名稱通常使用 requirements.txt，但不是硬性規定。當專案是 git clone 下來時，則使用下式安裝所需套件：

pip install -r requirements.txt

Flask 內建的 session 功能

本文的參考專案 https://github.com/shinder/flask-practice

• 使用 session 時，需要設定 cookie 的加密字串（secret key）。
• 取得 session 值，使用 session.get('鍵')。
• 設定 session 值，使用 session['鍵']=值。

from flask import session
from datetime import timedelta
import os

app.config['SECRET_KEY'] = os.urandom(24)
app.config['PERMANENT_SESSION_LIFETIME'] = timedelta(minutes=60)

@app.route('/try-session')
def try_session():
    if not session.get('what'):
        session['what'] = 1
    else:
        session['what'] += 1
    return str( session.get('what') )

Flask 路由路徑參數

本文的參考專案 https://github.com/shinder/flask-practice

• 路徑參數，可以使用角括號標示，如下範例的 action 和 id。
• 參數也可以指定類型，如 int。
• 可將多個路由定義疊起來，使用相同的函式處理，並能使用預設值。

@app.route('/params/')
@app.route('/params/<action>/')
@app.route('/params/<action>/<int:id>')
def my_params(action='none', id=0):
    return ( {
        'action': action,
        'id': id
    } )

Flask 接收表單資料及 query string

本文的參考專案 https://github.com/shinder/flask-practice

• request.args 可取得 GET 參數（query string）
• request.form 可取得 POST 參數（表單資料）
• request.files 可取得表單上傳的檔案

以下為取得 GET 和 POST 參數的例子：

@app.route('/try-qs')
def queryString():
    # query string 轉成 dict
    # http://localhost:5000/try-qs?a[]=1&b=34&a[]=5
    output = {
        'args': request.args,
        'a[]': request.args.getlist('a[]'),
        'get_b': request.args.get('b'),
        'get_a[]': request.args.get('a[]'),
    }
    return output

@app.route('/try-post', methods=['POST'])  # 限定使用 POST
def try_post():
    # 表單資料 urlencoded, form-data 皆可, 使用 postman 測試
    output = {
        'form': request.form,
        'a[]': request.form.getlist('a[]'),
        'post_b': request.form.get('b'),
        'post_a[]': request.form.get('a[]'),
    }
    return output

@app.route('/try-post2', methods=['POST'])
def try_post2():
    # 使用 postman post json 資料: {"a":11,"b":22}
    output = {
        'content_type': request.content_type,
        'data': request.data.decode('utf-8'),
        'json': request.get_json(),
    }
    return output

測試時，/try-post 和 /try-post2 可以使用 postman 測試。 getlist() 能取得所有相同名稱的參數，而拿到 list 類型的物件（陣列）。但不會將名稱有帶中括號的參數自動轉換為陣列。

使用 postman 將 json 文件 post 給 /try-post2 路由。request.data.decode('utf-8') 可以拿到字串；request.get_json() 可以拿到由 JSON 字串轉換而成的 dict 或 list。

Flask 的樣版系統 Jinja

本文的參考專案 https://github.com/shinder/flask-practice

Flask 樣版說明可以參考 這裡

在主程式加入以下片段：

from flask import render_template


@app.route('/basic-template')
def basic_template():
    return render_template('basic.html', name='是在哈囉', age=25)

@app.route('/basic-template2')
def basic_template2():
    output = {
        'name': '小明',
        'age': 30
    }
    return render_template('basic.html', ** output)

render_template() 用來呈現頁面，第一個參數為樣版檔（樣版檔必須放在 app/templates 資料夾內），第二個參數之後為欲傳入樣版的資料。

如 basic_template2() 也可以將資料包成 dict 然後再傳入。

樣版 app/templates/basic.html 的內容如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ name }}</title>
</head>
<body>
<h2>Hello, {{ name }}</h2>
<h6>{{ age }}</h6>
</body>
</html>

Flask 靜態檔案資料夾

在專案的資料夾的 app 內建立 static 資料夾，並在建立 app 物件時給第二個參數，指定路徑。

app = Flask(__name__, '/')

static 資料夾就會看成類似 apache 的 document root。

將處理的方法放到不同的 .py 檔

本文的參考專案 https://github.com/shinder/flask-practice

將處理的方法寫到 modules/functions.py 裡

from flask import request  # 滙入 request


def show_cookies():
    return request.cookies

在主要檔案 main.py 滙入：

import modules.functions

# 語法：add_url_rule(rule, endpoint=None, view_func=None, provide_automatic_options=None, **options)
app.add_url_rule('/show-cookies', 'show-cookies', modules.functions.show_cookies)
# app.add_url_rule('/show-cookies', 'show-cookies')
# app.view_functions['show-cookies'] = modules.functions.show_cookies

• 使用 add_url_rule() 可以將處理函式設定給路由。
• endpoint 用來做處理函式及路由的對應。給 None 時，則使用函式名稱。
• 這樣的方式可以將處理函式放在不同的檔案，以方便維護。

將 request headers 寫入檔案

本文的參考專案 https://github.com/shinder/flask-practice

from flask import request  # 滙入 request
import json

@app.route('/save-headers')
def save_headers():
    dict1 = {
        'cookies': {}
    }
    for i in request.headers:
        print(i)  # 查看取出的 headers 資料
        dict1[i[0]] = i[1]
    # 查看 cookies
    for i in request.cookies:
        dict1['cookies'][i] = request.cookies[i]
    file1 = open('headers.json', 'w')
    file1.write(json.dumps(dict1))  # 存成 JSON
    return dict1

• dict1 為用來暫存資料的 dict，並設定好結構
• request.headers 用 for/in 取出，為 tuple
• request.cookies 為 dict
• json 為預設套件，dumps 為轉換為 JSON 字串
• return dict 會自動轉換為 JSON 格式
• 拜訪 localhost:5000/save-headers 可以看到結果

建立 Flask 專案

建立 Flask 專案

本文的參考專案 https://github.com/shinder/flask-practice

首先如之前的文章 建立專案。

md flask-practice #建立專案資料夾
cd flask-practice #到專案目錄
python3 -m venv venv #安裝虛擬環境
source venv/bin/activate #啟動虛擬環境(mac)

安裝 Flask：

pip install flask

可以使用下列兩個命列中的一個查看安裝的套件：

pip list
pip freeze

建立 app 資料夾，用來存放自己撰寫的程式，並在裡面建立 main.py

from flask import Flask

# __name__ 用來 application 的相對位置
# 若是直接啟動的程式 __name__ 為 '__main__'
# 若是被滙入， __name__ 會是被滙入的名稱
app = Flask(__name__)

# decorators 後面定義的 function 會變成 decorators 的參數
# 類似 JavaScript 的 callback function
@app.route('/')
def index():
    return '<h2>哈囉 Flask</h2>'

在專案目錄建立執行的 run.sh，在 mac 記得將檔案屬性設定為 +x 可執行：

# mac
export FLASK_APP=app/main.py
export FLASK_ENV=development
flask run --host=localhost --port=5000

# windows
# set FLASK_APP=app/hello.py
# set FLASK_ENV=development
# flask run

在 terminal 執行 run.sh，並在瀏覽器拜訪 localhost:5000 即可看到我們的第一個頁面。