Djangoのviews.py周りにおける制約に関する備忘録

以下Qiitaの続きです。

https://qiita.com/thinking-weed/items/5e6946f765bffd2c725e

以前中止した学習用WebAPIの作成に向けて、とりあえず（３）の方法の通り、学習用Djangoプロジェクトのasgi.pyをいじって以下のようにFastAPIを埋め込みました。

<details><summary>詳細</summary>

```django_portfolio(プロジェクト全体)/django_portfolio（プロジェクト作成時にデフォルトできるフォルダ）/asgi.py
# Django の urls.py では WSGI ベースのアプリケーションを扱うため、
# FastAPI のような ASGI アプリを正しく組み込む必要があるらしい

import os
import django
from django.core.asgi import get_asgi_application
from fastapi import FastAPI
from starlette.middleware.wsgi import WSGIMiddleware
from starlette.routing import Mount
from starlette.applications import Starlette


# Django 環境変数を設定
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_portfolio.settings')

# Django を初期化
django.setup()

# Django ASGI アプリケーションを取得
django_app = get_asgi_application()

# FastAPI アプリを作成
fastapi_app = FastAPI()

@fastapi_app.get("/")
async def get_hello():
    return {"message": "Hello World"}

# FastAPI のエンドポイントを `/fastapi/` にマウント
app = Starlette(routes=[
    Mount("/fastapi", fastapi_app)  # "/fastapi" に FastAPI をマウント
])

# Django と FastAPI を共存させる ASGI アプリ
async def application(scope, receive, send):
    if scope["path"].startswith("/fastapi"):
        await app(scope, receive, send)  # FastAPI にルーティング
    else:
        await django_app(scope, receive, send)  # Django にルーティング
```

### ※上記の「/fastapi/にマウント」とは何か

これは、以下のコマンドでASGI（Asynchronous Server Gateway Interface）サーバーuvicorn (https://www.uvicorn.org/) を起動後、「http://127.0.0.1:8000/fastapi/ というエンドポイントにアクセスすると、埋め込んだFastAPIにアクセスできる」という意味です。
　**※「/fastapi」がFastAPIにアクセスするときのルートプレフィックスになっています。** （なお、このfastapiの部分は別に「fastapi」である必要は無い）

```powershell
uvicorn django_portfolio.asgi:application --reload
```
※このコマンドを起動すると以下のようにまず「http://127.0.0.1:8000/」 が表示されますが、**こちらにアクセスすると(/fastapiを避ければ) 「async def application～」の処理で Django (django_app) にルーティングされるため、Django のルート (urls.py に定義されたエンドポイント) に従います。**

![with_API⑥.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/1c1c884c-0842-32dc-c95b-e4e3808ca341.png)

※「/fastapi/」をつけてFastAPIにアクセスした様子

![with_API⑦.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/76eb5ff4-665d-41a2-b280-a75b1640dbc6.png)

</details>

_____

その後、依然全然何も分かってないので、Pythonの基礎の復習をしながら、[主な参考資料①](#主な参考資料)の内容をサンプルとして上記のDjangoプロジェクトに組み込む中で、**Djangoにおけるコントローラーであるviews.pyに周りにはいくつか制約がある**ことを知ったので、以下個人的な備忘録としてまとめました。（よく文章が冗長になりがちなので、urls.pyとかは省略します。そのへんは大丈夫なものとしてください）

## ①views.py内におけるdefから始まる処理（※）には、処理内に「request」となくとも引数に「request」を入れないとエラーになる。（※一般には「ビュー関数」と呼ぶようです。）

<details><summary>詳細</summary>

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
from django.http import HttpResponse

def Hello(request):    👈コイツ
    return HttpResponse("Hello World!")
```
あまり深く考えずに学習を進めていたんですが、学習の過程で久しぶりにreturnの後ろに render以外のものを書いていて気づきました。ドキュメントにも以下のようにありました。クラス内におけるselfと似ていますが、**request は HttpRequest のインスタンスである**のに対し、**self は何らかの「クラス」のインスタンスであることが違います。（要は「クラス内のメソッド」の第１引数として書く）**

![スライド1.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/f692c245-f0ed-403c-9ccb-7fa004237689.png)

※上記の公式ドキュメントURL
https://docs.djangoproject.com/ja/5.1/topics/http/views/#:~:text=views.py%20%E3%81%A8%E3%81%84%E3%81%86%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%AB%E3%83%93%E3%83%A5%E3%83%BC%E3%82%92%E8%A8%98%E8%BF%B0%E3%81%97%E3%81%BE%E3%81%99%E3%80%82

例えば「request」一見処理に使ってないじゃんと思って
```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
from django.http import HttpResponse

def Hello():    
    return HttpResponse("Hello World!")
```
などと書くとルーティングとか他は書けていても以下のようなエラーが出ます

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/12a833f3-e308-43d4-b29d-160a379cb63d.png)

</details>

## ②views.py内におけるビュー関数において、レスポンス処理として返すものはHttpResponseオブジェクトまたはそのサブクラスである必要がある

<details><summary>詳細</summary>

ドキュメントにも以下のようにありました。**「要はreturnとか使ったらHttpresponseとかそのサブクラス（よく使うものだと「JsonResponse」）の中に最終的に入れて返り値を返せ」** 的な意味です

![スライド2.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/f529a533-2432-4af4-a963-bfeba6abb584.png)

![スライド3.PNG](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/362b45e8-60f5-4b3c-8a89-b201a61afc7f.png)

※上記の公式ドキュメントURL
https://docs.djangoproject.com/ja/5.1/ref/request-response/#:~:text=JsonResponse%20%E3%82%AA%E3%83%96%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88

_____

### エラーになる例（２）　文字列オブジェクトは返せない

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
from django.http import HttpResponse

def Hello(request):    
    return "Hello World!"
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/49d82967-3d4b-441b-984d-f6f34b1d5576.png)

### エラーになる例（３）　普段のprint()の書き方

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
from django.http import HttpResponse

def Hello(request):    
    print("Hello World!")
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/1234ed7a-fe6d-4a63-983b-2856b3285ea4.png)

**※注意　いずれの場合においてもPythonがインタープリター言語のためか、他の部分にエラーがなければ、開発用サーバーを起動すると、開発用サーバーは動きます。またその際、他のエンドポイントはそのエンドポイントにエラー無ければアクセスできます**

_____

なお、printをどうしても使いたい場合例えばこうすればいけるようです。
```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
def Hello_World(request):
    print("Hello World!",request.GET)
    return HttpResponse()　👈やっぱりコイツ（かそのサブクラス）
```
なお、これのエンドポイントにアクセスすると、ブラウザは真っ白、ターミナルにprintの値が出力されます。（ここまで書いたらreturn HttpResponseに突っ込むと思いますが(-_-;)）
</details>

## ③出力結果として返される何らかの配列からクヴォーテーションをどうしても取り除きたい場合、join()、f-strings、isliceなどを使ってなんとかしないといけない

地味にこれが結構厄介でした。

（※isliceはPythonの標準ライブラリーitertoolsに入っている関数です。詳しくは[主な参考資料⑤](#主な参考資料)を参照）

<details><summary>詳細</summary>

例えば、以下のビュー関数を出力すると次のようになります。
```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
from django.http import JsonResponse,HttpResponse

def sample(request):
    sample_list = ('hogehoge', "fugafuga")
    sample_dict = {'a': 1, "b": 2, 'c': 3}
    params = [
        sample_list,
        sample_dict
    ]
    return HttpResponse(params)
```
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/78741b50-d2af-4a43-9014-a973f4b32000.png)

______

### 〇とりあえず見やすさのために改行

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
def sample(request):
    sample_list = ('hogehoge', "fugafuga")
    sample_dict = {'a': 1, "b": 2, 'c': 3}
    params = [
        sample_list,
        sample_dict
    ]
    # 各要素を個別に文字列化し、改行（<br>）で結合　　
    results = "<br>".join(str(param) for param in params)　#👈
    return HttpResponse(results)　#👈
```

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/5097d346-c171-404b-942b-07d4cf6107fa.png)

______

### 〇シングルクォーテーションを取り除いて「見かけ上」配列にする

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
def sample(request):
    sample_list = ('hogehoge', "fugafuga")
    sample_dict = {'a': 1, "b": 2, 'c': 3}
    params = [
        #sample_listを「見かけ上」シングルクォーテーションがないタブルになっていないように整形
        f"({','.join(f'{value}' for value in sample_list)})",　#👈
        #sample_dictを「見かけ上」シングルクォーテーションがない辞書になっていないように整形
        "{"+f"{','.join(f'{key}: {value}' for key, value in sample_dict.items())}"+"}" #👈
    ]
    # 各要素を個別に文字列化し、改行（<br>）で結合
    results = "<br>".join(str(param) for param in params)
    return HttpResponse(results)
```
このときの出力結果（※あくまで文字列が連結されているものが出力されていることに注意）

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/e36e4e2c-2062-42c1-b339-fa9a119ee088.png)

______

### 〇特定のkeyをisliceを使って抽出（このとき、シングルクォーテーションは付かない）

```django_portfolio(プロジェクト全体)/sample_app(作成したアプリ)/views.py
def sample2(request):
    sample_dict = {'a': 1, "b": 2, 'c': 3}
    #islice(data.keys(), 1, 2) は、キーのリストからインデックス 2 から 3 の範囲をスライス
    key_at_index_1 = next(islice(sample_dict.keys(), 2, 3))
    # islice(iterable, start, stop)
    # iterable: イテラブルオブジェクト（この場合、sample_dict.keys()
    # start: 開始インデックス（この場合、2）
    #stop: 終了インデックス（この場合、3）※ このインデックスは含まれない（👈重要）
    #next()で最初の値を取得
    result = f"要素の左から３番目の key は {key_at_index_1}"
    return HttpResponse(result)
```
※基本中の基本だと思うのですが当然Pythonの配列も一番最初の要素のindexは「0」であることに気をつけてください。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/3584834/65c047bf-764f-4317-acea-b49291d27ee7.png)
</details>

_______

### ※Pythonにおいて出力結果・取得結果にシングルクォーテーションが入っていると問題になりうるケース

Chat-GPTに尋ねてみたところ、以下のようなケースが挙げられました。

①SQLクエリ（SQLインジェクションのリスク）
②JSONフォーマット（JavaScriptでのパースエラー）
③シェルコマンド（コマンドインジェクションのリスク）
**④URLパラメータ（エンコードしないと壊れる）**
⑤CSVファイル（パースエラーの可能性）

_____

冒頭の作成を再開しようとしているWebAPI（を組み込んだプログラム）は「短縮URL」で、当時（のモブプロ）は[参考資料⑥](#主な参考資料)のようにFlask & SQLiteでの開発を計画していました。上記③は「そこでもしかすると使うかも」と思い検証した結果です。実際使うかは？ですが、作成過程は別にまたQiitaに起こします。

## 主な参考資料

①Python FastAPI本格入門　樹下雅章（著） 技術評論社

<details><summary>Amazonリンク</summary>

https://www.amazon.co.jp/Python-FastAPI%E6%9C%AC%E6%A0%BC%E5%85%A5%E9%96%80-%E6%A8%B9%E4%B8%8B-%E9%9B%85%E7%AB%A0/dp/4297144476/ref=asc_df_4297144476?mcid=bfc5ec993f7a3ee396fb7893dbd7012c&th=1&psc=1&tag=jpgo-22&linkCode=df0&hvadid=707442440817&hvpos=&hvnetw=g&hvrand=7983464261924109978&hvpone=&hvptwo=&hvqmt=&hvdev=c&hvdvcmdl=&hvlocint=&hvlocphy=1009539&hvtargid=pla-2337171162442&psc=1&gad_source=1
</details>

②FastAPI × Uvicorn：最強のAPI高速化コンビ誕生！　@Leapcell (leapcell)さんQiita
https://qiita.com/Leapcell/items/0c0bf5e0fe84b3356c82

③WebAPIについての説明　@busyoumono99 さんQiita
https://qiita.com/busyoumono99/items/9b5ffd35dd521bafce47

④Python 3: print と return について（超基礎）　@orange_u (おれんじ) さんQiita
https://qiita.com/orange_u/items/5a769459dcaa5e06c15b

⑤isliceの紹介、具体例添え(pythonのitertoolsを使いこなすために)　@shihono さんQiita
https://qiita.com/shihono/items/1613f7c6c1b096256bd3

⑥【初めてのAPI】短縮URLを発行するAPIの開発【Flask + SQLite】 @yurikomium (Yuriko Kikuchi)さん Qiita
https://qiita.com/yurikomium/items/6dc3b3d733b40e4b5f6a