グラハム・ダンプルトン:JupyterLabのためのワークシ... ノート

グラハム・ダンプルトン:JupyterLabのためのワークショップ執筆

このテキストは、pytestを教えることに焦点を当てたJupyterLabワークショップの作成について説明しています。 ワークショップは、ブログ記事に収まるほど小さいながらも、実際のワークショップのすべての必須要素を含んでいます。 マニフェスト、複数のページ、インタラクティブなアクション、自動チェック、クイズ、およびサポートツールが含まれています。 ワークショップでは、テストの記述、失敗の観察、そしてコードの修正という、pytestの基本的なループを教えます。 この反復的なプロセスは、ワークショップ内の4つの異なるページにわたって構成されています。 重要な機能は、ワークショップのために分離されたPython環境を作成し、学習者のシステムに影響を与えることなくpytestがインストールされることを保証することです。 このアプローチは、以前のカンファレンストークからのコンテンツレッスンを活用して、学習体験を向上させます。 プロセスは、計画と検証可能なステップの定義から始まり、ワークショップとチュートリアルを区別します。 ワークショップは jupyter workshop init コマンドを使用して生成され、ディレクトリ構造とマニフェストファイルが設定されます。 ターミナルアクセス、ファイル書き込み、コード実行、パッケージインストールなどの機能はマニフェストで宣言され、リンターによって検証されます。 マニフェストの environment フィールドは、pytestなどの依存関係を指定し、これらは自己完結型の仮想環境にインストールされます。 これにより、手動での環境設定が不要になり、学習者はpytest自体に集中できます。 マニフェストの env エントリは、頻繁なファイル変更による問題を回避するために、Pythonバイトコードキャッシュも無効にします。 ワークショップでは、学習者がデバッグするための意図的にバグのある関数を含む files/orders.py ファイルを使用します。 ワークショップの各ページは、Markdownと特定のアクションブロックを使用して、ファイルの開き方、コードの記述、コマンドの実行などのタスクを学習者にガイドします。 チェックは verify アクションを使用して実装され、学習者のアクションの結果を自動的に検証し、進捗と学習を保証します。 quiz アクションは、学習者にテストを実行する前に結果を予測するように促し、pytestの動作方法の理解を強化します。 editor-insert アクションにより、テストなどの新しいコードをエディタに直接追加して表示できます。 ワークショップの構造とコンテンツは、インタラクティブで教育的なものになるように設計されており、pytestの実践的な応用に焦点を当てています。
CdXz5zHNQW_hkEwNEOUhk.png