[feat] Refine stapy Oct LT

source/stapy-oct/introduction-flake8-kotoha.rst

@@ -1,8 +1,8 @@
 ======================================================================
-関数の引数の型ヒントをカイゼンするflake8 pluginを作りました！！
+関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！
 ======================================================================
 
-関数の引数の型ヒントをカイゼンするflake8 pluginを作りました！！
+関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！
 ======================================================================
 
 :Event: みんなのPython勉強会#109 LT
@@ -11,18 +11,18 @@
 お前、誰よ
 ======================================================================
 
-* nikkie ／ :fab:`github` `@ftnext <https://github.com/ftnext>`__ ／ `ブログ <https://nikkie-ftnext.hatenablog.com/>`__ 連続 **690** 日突破
+* nikkie ／ :fab:`github` `@ftnext <https://github.com/ftnext>`__ ／ `ブログ <https://nikkie-ftnext.hatenablog.com/>`__ 連続 **700** 日達成
 * 機械学習エンジニア・自然言語処理（`We're hiring! <https://hrmos.co/pages/uzabase/jobs/1829077236709650481>`__）
 * `みんなのPython勉強会 <https://startpython.connpass.com/>`__ スタッフ・4代目LT王子
 
 .. image:: ../_static/uzabase-white-logo.png
 
-型ヒント
+Pythonの型ヒント
 ======================================================================
 
 書いている方🙋‍♂️
 
-Python 3.5から型ヒントが書けるようになった
+Python **3.5** から型ヒントが書けるように！
 --------------------------------------------------
 
 .. code-block:: python
@@ -33,25 +33,28 @@ Python 3.5から型ヒントが書けるようになった
     
     greeting("stapy")  # 'Hello stapy'
 
-型チェッカが使う
+🏃‍♂️ `拙ブログ 型ヒントの出自を調べた記事 <https://nikkie-ftnext.hatenablog.com/entry/python-type-hints-origin-python35>`__
+
+型ヒントは型チェッカが使う
 --------------------------------------------------
 
 * Python処理系が実行するとき、型ヒントは無視
 * 型チェッカ（例：mypy）で **型ヒントをチェック** する
 
 .. code-block:: python
 
-    # error: Argument 1 to "greeting" has incompatible type "int"; expected "str"  [arg-type]
+    # error: Argument 1 to "greeting" has ↵
+    # incompatible type "int"; expected "str"  [arg-type]
     greeting(42)
 
-実行時は無視されるとはいっても、書くと便利
+実行時に無視されても、書くと便利（IMO）
 --------------------------------------------------
 
 * 処理系で実行する前に **エラーになることに気づける**
 * 型チェッカではなく **人が読む前提** で型ヒントを書くことで情報量を増やせる
 
-この型ヒントは、Python公式ドキュメントで推奨？ 非推奨？ クイズ！！！！
-======================================================================
+この型ヒントは、Python公式ドキュメントで 好ましい？ 好ましくない？ クイズ！！！！
+==========================================================================================
 
 要素に1を加える関数の型ヒント
 --------------------------------------------------
@@ -63,7 +66,7 @@ Python 3.5から型ヒントが書けるようになった
 
     plus_one([1, 2, 3])  # [2, 3, 4]
 
-Python公式ドキュメントで推奨？ 非推奨？
+Python公式ドキュメントで 好ましい？ 好ましくない？
 
 ヒント：引数の型ヒント
 --------------------------------------------------
@@ -76,9 +79,9 @@ Python公式ドキュメントで推奨？ 非推奨？
     ) -> list[int]:
         return [n + 1 for n in numbers]
 
-Python公式ドキュメントで推奨？ 非推奨？
+Python公式ドキュメントで 好ましい？ 好ましくない？
 
-答え：非推奨🙅‍♀️！！
+答え：好 ま し く **な い** 🙅‍♀️ ！！
 ======================================================================
 
     Note that to annotate arguments, it is preferred to use an abstract collection type such as Sequence or Iterable rather than to use list or typing.List.
@@ -88,18 +91,18 @@ https://docs.python.org/ja/3/library/typing.html#typing.List
 意訳
 --------------------------------------------------
 
-    関数の引数を型ヒントするとき、listよりもSequenceやIterableのような抽象コレクション型を使うのが好ましい
+    関数の引数を型ヒントするとき、listよりも **SequenceやIterableのような抽象コレクション型** を使うのが好ましい
 
 公式ドキュメントを元にした私の考え
 --------------------------------------------------
 
-.. code-block:: python
-    :emphasize-lines: 1,4
+.. code-block:: diff
 
-    from collections.abc import Iterable
+    +from collections.abc import Iterable
 
     def plus_one(
-        numbers: Iterable[int]
+    -    numbers: list[int]
+    +    numbers: Iterable[int]
     ) -> list[int]:
         return [n + 1 for n in numbers]
 
@@ -113,11 +116,11 @@ Iterable
 その引数の型ヒント、本当に ``list`` ですか？
 --------------------------------------------------
 
-* ``list`` を渡して呼び出してはいる
+* ``list`` を渡して関数を呼び出してはいる
 * **タプルを渡しても** 動く（``range`` やジェネレータでも。これらは皆イテラブル）
 * 表したいのは「整数を要素としていて **forで回せる**」なのでは？
 
-関数の引数の型ヒントをカイゼンするflake8 pluginを作りました！！
+関数の引数の型ヒントをカイゼンするFlake8 pluginを作りました！！
 ======================================================================
 
 .. code-block:: shell
@@ -132,29 +135,58 @@ https://pypi.org/project/flake8-kotoha/
 --------------------------------------------------
 
 * コードを実行せずに解析（＝静的解析）して、スタイルや問題を指摘
-* プラグインを書けるので、「その引数の型ヒント、本当に ``list`` か」問うプラグインをこのたび実装
+* **プラグインを書ける** ので、「その引数の型ヒント、本当に ``list`` か」問うプラグインをこのたび実装
 
 flake8-kotoha「引数の型ヒントをlistにしてはいけません」
 ------------------------------------------------------------
 
 .. code-block:: shell
 
+    $ uv tool install flake8 --with flake8-kotoha
     $ flake8 example.py
     example.py:1:14: KTH101 Type hint with abstract type `collections.abc.Iterable` or `collections.abc.Sequence`, instead of concrete type `list`
 
 なぜRuffでなくてFlake8？
 ------------------------------------------------------------
 
-* Rust実装の高速なリンター兼フォーマッタ Ruff がFlake8・Black・isortなどを置き換えていっているように映る
+* Rust実装の高速なリンター兼フォーマッタ Ruff （`Python Monthly Topics <https://gihyo.jp/article/2023/03/monthly-python-2303>`__）がFlake8・Black・isortなどを置き換えていっているように映る
 * **Ruffにplugin機構が現時点でなさそう** だからです（あったらやりたいので情報求ム）
 
 まとめ🌯 関数の引数の型ヒントをカイゼンするflake8 pluginを作りました！！
 ================================================================================
 
-* 関数の引数に ``list`` を渡していたとしても、``list`` を使った型ヒントが好ましいとは限らない
+* 関数の引数に ``list`` を渡していたとしても、``list`` を使った型ヒントが好ましいとは **限らない**
 * 自作した flake8-kotoha 「引数の型ヒントをlistにしてはいけません」
 
 ご清聴ありがとうございました
 --------------------------------------------------
 
 Kaizen Type Hint💪
+
+:fab:`github` `ftnext/kotoha-python-linter <https://github.com/ftnext/kotoha-python-linter>`__
+
+Appendix
+======================================================================
+
+関連アウトプット
+--------------------------------------------------
+
+* 『`引数の型ヒントをlistにしてはいけません <https://everlastingdiary.booth.pm/items/5734862>`__』
+* `イベントレポート | #技書博 10で小冊子『引数の型ヒントをlistにしてはいけません』を頒布しました <https://nikkie-ftnext.hatenablog.com/entry/thank-you-gishohaku10-python-type-hint-dont-use-list-for-parameters>`__
+
+関連記事
+--------------------------------------------------
+
+* `琴葉ちゃん「引数の型ヒントをlistにしてはいけません」をflake8のプラグインとして実装しました <https://nikkie-ftnext.hatenablog.com/entry/imas-hack-2024-release-flake8-kotoha-0.1.0>`__
+* `flake8 pluginの作りかた（抽象構文木ベースのpluginを作るまで） <https://nikkie-ftnext.hatenablog.com/entry/how-to-create-ast-based-flake8-plugin>`__
+
+スライドの秘密 〜お前、誰よ 補足〜
+--------------------------------------------------
+
+attakeiさんの `sphinx-revealjs <https://pypi.org/project/sphinx-revealjs/>`__ に以下の **自作拡張** を組み合わせて実現
+
+* `sphinx-new-tab-link <https://pypi.org/project/sphinx-new-tab-link/>`__
+* `sphinx-revealjs-copycode <https://pypi.org/project/sphinx-revealjs-copycode/>`__
+
+EOF
+===