{ "cells": [ { "cell_type": "markdown", "metadata": { "tags": [] }, "source": [ "![](images/python_with_Birds.gif)\n" ] }, { "cell_type": "markdown", "metadata": { "id": "waZDna5nPCfT" }, "source": [ "\n", "# Python Modules - วิธีการสร้าง \n", "\n", "**10** minutes\n", "\n", " **วัตถุประสงค์**\n", "\n", " หลังจากทำทำแล็บ นศ.จะสามารถ \n", "\n", "* เขียนโมดูลและใช้โมดูลที่สร้างขึ้นเองได้\n", "* ใช้ (Line & Cell) Magic Commands ใน IPython ได้\n", "\n", "Ref：\n", "* https://docs.python.org/3/tutorial/modules.html\n", "* https://docs.python.org/3/reference/import.html" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "โดยทั่วไป การเขียนโปรแกรมที่มีการนำไปใช้ประโยชน์ได้อย่างจริงจัง โปรแกรมจะมีขนาดใหญ่ ดังนั้นจึงมีความจำเป็นต้องแยกโปรแกรมออกเป็นส่วนๆ (หลายๆ ไฟล์) เพื่อให้ง่ายต่อการจัดการและแก้ไขโปรแกรม จนถึงการพัฒนาต่อยอดโปรแกรม\n", "\n", "Python เรียกแต่ละส่วนที่แยกออกมาว่า **โมดูล (module)** มีนามสกุลไฟล์ (Extension) เป็น .py \n", "\n", "\n", "## ไฟล์โมดูล\n", "\n", "ไฟล์โน๊ตบุ๊ค (Extension `.ipynb` (IPython Notebook); IPython kenel: Jupyter Notebook, IPython Notebook) ที่เราเขียนที่ผ่านๆ มา เก็บทั้งไพธอนซอสโค๊ด (Soure code) ใน _Code cell_ ข้อความเอกสาร (Markdown-formatted document/text) ใน _Markdown cell_ และผลลัพธ์ของการรันใน _Output cell_ ไว้ในไฟล์เดียว \n", "แต่สำหรับไฟล์ดโมดูล （Extension `.py`）เป็นไฟล์ที่มีเฉพาะไพธอนซอสโค๊ดเท่านั้น\n", "\n", "ดังนั้น การใช้โน๊ตบุ๊กเขียนโมดูลต้องเขียนเฉพาะไพธอนซอสโค๊ด (Code cell) เท่านั้น" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### วิธีการเปลี่ยนไฟล์โน๊ตบุ๊คเป็นไฟล์โมดูล\n", "\n", "หลังจากที่เราเขียนไพธอนซอสโค๊ดในไฟล์โน๊ตบุ๊คแล้ว เราก็ต้องเปลี่ยนไฟล์โน๊ตบุ๊ค (.ipynb) ให้เป็นไฟล์โมดูล (.py) โดยการ...\n", "* หากเขียนด้วย Jupyter notebook ให้กดตรงแถบเมนู \"File\" เลือก \"Download as\" แล้วคลิก \"Python (.py)\" ตั้งชื่อไฟล์ที่ต้องการเซฟ\n", "* หากเขียนด้วย Jupyter lab ให้กดตรงแถบเมนู \"File\" เลือก \"Export Notebook as\" แล้วคลิก \"Notebook to Executable Script\" ตั้งชื่อไฟล์ที่ต้องการเซฟ\n", "\n", "ก็จะได้ไฟล์ที่มีเฉพาะซอสโค๊ด (ส่วนอื่นๆ ที่ไม่ใช่ซอสโค๊ดจะกลายเป็น Comment) มีเป็นนามสกุลเป็น .py\n", "\n", "\n", "โดยปรกติไฟล์ทั้งหมด ทั้งไฟล์โปรแกรมหลักและไฟล์โมดูลต่างๆ จะถูกเก็บไว้ที่ Directory (Folder) เดียวกัน เราสามารถใช้ **Line magic command** `%pwd` ตรวจสอบ Directory (Folder) ที่กำลังใช้งานอยู่ได้ " ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "'/Users/tube.sc/Data_KMITL/Courses_onMac/2021_Python'" ] }, "execution_count": 1, "metadata": {}, "output_type": "execute_result" } ], "source": [ "%pwd" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "
\n", "\n", "**Note:**\n", "**[Magic Commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html) ☜** \n", "%pwd เป็นคำสั่งที่ใช้เฉพาะในกรณีที่รันภายใต้ IPython (Interactive Python) เช่น Jupyter notebook, JupyterLab, Google Colaboratory (Colab) เท่านั้น เมื่อรันคำสั่งนี้ จะแสดงผลลัพธ์ในเซลล์เอาต์พุตและบันทึกเก็บในโน้ตบุ๊กได้\n", "\n", "Magic Commands อื่นๆ เช่น %system date โดยสามารถพิมพ์คำสั่ง `%lsmagic` ลงใน Code cell เพื่อแสดงลิสต์ของ Magic Command ทั้งหมดได้ (ดูรายละเอียดในลิงค์ข้างบน)\n", "
\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "ในการเซฟไฟล์ให้เป็น .py นอกเหนือจากวิธีปรกติข้างต้นแล้ว ยังอีกวิธีที่สามารถทำได้เช่นกัน \n", "\n", "นั่นคือ ใช้คำสั่ง **Cell magic command** `%%file `\n", "\n", "เช่น ในกรณีที่เราได้เขียนโค้ดฟังก์ชัน `fact()` (ฟังก์ชันคำนวณค่าแฟกทอเรียล (Factorial) $n!$ ) ขึ้นมา แล้วต้องการเซฟเฉพาะ Cell ดังกล่าวให้อยู่ในรูปของไฟล์ โดยมีชื่อว่า factorial.py ก็สามารถทำได้โดยใช้คำสั่ง `%%file factorial.py` ดังตัวอย่างต่อไปนี้\n", "\n", "
\n", "Note: คำสั่ง Cell Magic Command ต้องอยู่บรรทัดแรกสุดของ cell เสมอ\n", "
\n" ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "Overwriting factorial.py\n" ] } ], "source": [ "%%file factorial.py\n", "\n", "# คืนค่ากลับเป็นค่าแฟคทอเรียล n! \n", "def fact(n):\n", " prod = 1\n", " for i in range(1, n + 1):\n", " prod *= i\n", " return prod" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "*** Note: ***\n", "\n", "\"ตรงโค้ดตั้งแต่ cell magic command %%file factorial.py ผมลองรันแล้วมัน PermissionError\n", "แต่ผมลองเอาโค้ดมาใส่ใน Visual Studio Code แล้วมันรันได้ปกติ ผมอยากให้อาจารย์ช่วยตรวจสอบและแก้ไขเรื่องการรันโค้ดด้วยครับ\"\n", "\n", "เหตุผลเพราะว่า นศ เปิดไฟล์ใน /scratch แล้วรัน หรือไม่ก็ save as ใน directory ตัวเองแล้ว รันคำสั่งเลยโดยที่ไม่ได้ shutdown kernal แล้วเปิดใหม่ใน directory ตัวเองก่อน " ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## วิธีการใช้โมดูลที่สร้างขึ้น\n", "\n", "การใช้ฟังก์ชันที่ถูกกำหนดไว้ในโมดูลสามารถทำได้โดยการใช้คำสั่ง **`import`** และชื่อโมดูล โดยเขียนในรูปแบบ\n", "\n", "`import `\n", "\n", "**ชื่อโมดูล ** คือชื่อไฟล์โมดูลที่ตัดนามสกุล `.py` ทิ้งนั่นเอง\n", "\n", "และตอนที่จะเรียกฟังก์ชันที่อยู่ในโมดูล ก็สามารถเรียกใช้ได้ในรูปแบบ \n", "\n", "`.`\n", "\n", "\n", "ยกตัวอย่างเช่น เรามีไฟล์ `factorial.py` ซึ่งเป็นไฟล์มีฟังก์ชัน `fact()` เขียนไว้อยู่ แล้วเราต้องการโหลดโมดูลนี้เข้ามาใช้ โดยอยู่บนสมมติฐานที่ว่า ไฟล์ `factorial.py` ถูกเก็บอยู่ใน Directory (Folder) เดียวกันไฟล์หลัก (ไฟล์ที่เขียนอยู่นี้)\n", "\n", "_factorial.py:_\n", "\n", "```Python\n", "# คืนค่ากลับเป็นค่าแฟคทอเรียล n! \n", "def fact(n):\n", " prod = 1\n", " for i in range(1, n + 1):\n", " prod *= i\n", " return prod\n", "```" ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "720" ] }, "execution_count": 1, "metadata": {}, "output_type": "execute_result" } ], "source": [ "import factorial\n", "\n", "factorial.fact(6)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "การใช้คำสั่ง `from` หรือคำสั่ง `as` ก็เหมือนกับโมดูลที่มีอยู่ทุกประการ\n", "\n", "หากต้องการใช้ชื่อเดียวกับชื่อที่กำหนดไว้ในโมดูล ก็สามารถเขียนดังต่อไปนี้โดยใช้คำสั่ง **`from`**" ] }, { "cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "720" ] }, "execution_count": 4, "metadata": {}, "output_type": "execute_result" } ], "source": [ "from factorial import fact\n", "\n", "fact(6)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "การนำเข้าทั้งหมดโดยการใช้เครื่องหมายสตาร์ **`*`** ก็สามารถทำได้ แต่เป็นวิธีที่ไม่แนะนำ\n", "\n", "เนื่องจากวิธีดังกล่าวเป็นการนำเข้าออบเจ็กต์ทุกอย่าง (ตัวแปร ฟังก์ชัน คลาส ฯลฯ) ที่มีอยู่ในโมดูลเข้ามาในโปรแกรมหลัก ซึ่ง\n", "อาจจะมีชื่อออบเจ็กต์ที่เราไม่รู้ว่ามีอยู่ในโมดูล และชื่อนั้นซ้ำกับชื่อในโปรแกรมหลัก ทำให้เกิดความขัดแย้งกัน (Name conflict, name collision)" ] }, { "cell_type": "code", "execution_count": 5, "metadata": {}, "outputs": [], "source": [ "from factorial import *" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "หากคุณต้องการใช้ชื่ออื่น เช่น เนื่องจากชื่อโมดูลยาวเกินไป ก็สามารถตั้งชื่อที่ต้องการด้วยคำสั่ง **`as`**" ] }, { "cell_type": "code", "execution_count": 6, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "720" ] }, "execution_count": 6, "metadata": {}, "output_type": "execute_result" } ], "source": [ "import factorial as f\n", "\n", "f.fact(6)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "หากต้องการเช็คเส้นทางที่เก็บซอสโค๊ด (source code) ของโมดูลที่ import เข้ามา สามารถเรียกดูได้จากตัวแปร ```__file__```\n" ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [ { "data": { "text/plain": [ "'/Users/tube.sc/Data_KMITL/Courses_onMac/2021_Python/factorial.py'" ] }, "execution_count": 2, "metadata": {}, "output_type": "execute_result" } ], "source": [ "factorial.__file__" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": { "id": "77G0KQCTPCfv" }, "source": [ "## Author\n", "\n", "S.C.\n", "\n", "### Change Log\n", "\n", " \n", "| Date | Version | Change Description |\n", "|---|---|---|\n", "| 25-12-2021 | 0.1 | First edition |\n", "| | | |\n", "| | | |\n" ] } ], "metadata": { "kernelspec": { "display_name": "Python 3 (ipykernel(3.8.13))", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.13" }, "latex_envs": { "LaTeX_envs_menu_present": true, "autoclose": false, "autocomplete": true, "bibliofile": "biblio.bib", "cite_by": "apalike", "current_citInitial": 1, "eqLabelWithNumbers": true, "eqNumInitial": 1, "hotkeys": { "equation": "Ctrl-E", "itemize": "Ctrl-I" }, "labels_anchors": false, "latex_user_defs": false, "report_style_numbering": false, "user_envs_cfg": false }, "toc": { "base_numbering": 1, "nav_menu": {}, "number_sections": true, "sideBar": true, "skip_h1_title": true, "title_cell": "Table of Contents", "title_sidebar": "Contents", "toc_cell": false, "toc_position": {}, "toc_section_display": true, "toc_window_display": false } }, "nbformat": 4, "nbformat_minor": 4 }