l21: start dataclass

Author: Saeid Darvish

lessons/l07.rst

@@ -1094,7 +1094,7 @@
 تبدیل به نوع رشته
 ~~~~~~~~~~~~~~~~~~~~
 
-برای تبدیل اشیایی از نوع دیگر به نوع رشته؛ کلاس ``()str`` [`اسناد پایتون <http://docs.python.org/library/functions.html#str>`__] و تابع ``()repr`` [`اسناد پایتون <http://docs.python.org/library/functions.html#repr>`__] وجود دارد. کلاس ``()str`` یک نمونه غیر رسمی (informal) از نوع شی رشته را برمی‌گرداند؛ غیر رسمی از این جهت که توسط آن جزییات شی رشته پنهان می‌شود. اما تابع ``()repr`` یک نمونه رسمی (official) از نوع رشته پایتون را برمی‌گرداند. کمی قبل‌تر راجب تفاوت خروجی ``print`` و حالت تعاملی صحبت کردیم؛  در واقع خروجی ``()str`` مناسب برای چاپ است و همانند ``print`` جزییات این نوع شی را ارایه نمی‌دهد در حالی که ``()repr`` به مانند حالت تعاملی یک ارايه (representation) کامل از شی رشته را برمی‌گرداند::
+برای تبدیل اشیایی از نوع دیگر به نوع رشته؛ کلاس ``()str`` [`اسناد پایتون <http://docs.python.org/library/functions.html#func-str>`__] و تابع ``()repr`` [`اسناد پایتون <http://docs.python.org/library/functions.html#repr>`__] وجود دارد. کلاس ``()str`` یک نمونه غیر رسمی (informal) از نوع شی رشته را برمی‌گرداند؛ غیر رسمی از این جهت که توسط آن جزییات شی رشته پنهان می‌شود. اما تابع ``()repr`` یک نمونه رسمی (official) از نوع رشته پایتون را برمی‌گرداند. کمی قبل‌تر راجب تفاوت خروجی ``print`` و حالت تعاملی صحبت کردیم؛  در واقع خروجی ``()str`` مناسب برای چاپ است و همانند ``print`` جزییات این نوع شی را ارایه نمی‌دهد در حالی که ``()repr`` به مانند حالت تعاملی یک ارايه (representation) کامل از شی رشته را برمی‌گرداند::
 
     >>> str(14)
     '14'

lessons/l21.rst

@@ -27,6 +27,175 @@
 Data Classes
 ----------------------------
 
+از **نسخه 3.7 پایتون** یک ویژگی جالب به پایتون اضافه گردید. دیتا کلاس **(Data Class)**، در واقع یک سینتکسی ساده‌سازی شده برای ایجاد کلاس‌هایی که معمولا تنها حاوی Instance Attribute می‌باشند. این نوع کلاس با استفاده از دکوراتور ``dataclass@`` از ماژول ``dataclasses`` ایجاد می‌گردد [`اسناد پایتون <https://docs.python.org/3/library/dataclasses.html>`__]. برای مثال کلاس زیر را در نظر بگیرید:
+
+
+.. code-block:: python
+    :linenos:
+
+    from dataclasses import dataclass
+
+    @dataclass
+    class Student:
+        name: str
+        score: int
+
+    student = Student('Saeid', 70)
+    print(student)
+    print('-' * 30)
+    print(student.name)
+    print(student.score)
+    print('-' * 30)
+    print(Student('Saeid', 70) == Student('Saeid', 70))
+
+::
+
+    Student(name='Saeid', score=70)
+    ------------------------------
+    Saeid
+    70
+    ------------------------------
+    True
+
+
+در این نوع کلاس برای تعریف Attributeها از سینتکس  Variable Annotations [`PEP 526 <https://www.python.org/dev/peps/pep-0526/>`__] استفاده می‌شود. این سینتکس و در کل ذکر نوع داده در پایتون یا Type Hints [`PEP 484 <https://www.python.org/dev/peps/pep-0484/>`__] **موضوع درس بعدی است**. در این شیوه نوع متغیرها به صراحت ذکر می‌گردد. در حالت عادی تعریف یک متغییر در زبان برنامه‌نویسی پایتون به صورت ``var = value`` می‌باشد (درس ششم)، همانطور که می‌دانیم تاکنون هیچ‌گاه در پایتون برای تعریف متغییر نیازی به ذکر صریح نوع داده نمی‌بود، **اکنون نیز نیازی نیست**، ولی از **نسخه 3.6 پایتون** می‌توانیم اینکار را انجام دهیم، می‌توانیم نوع داده را خودمان مشخص کنیم یا به اصطلاح آن نوع را annotation کنیم. سینتکس این عملیات به صورت ``var: annotation`` می‌باشد، این سینتکس مشخص می‌کند که متغییر var از نوع annotation می‌باشد. همچنین با استفاده از سینتکس ``var: annotation = value`` نیز می‌توان همزمان عملیات انتساب و مقداردهی را نیز انجام داد. باید توجه داشت که تغییری در ساختار مفسر پایتون ایجاد نشده است!، بلکه صرفا سینتکس جدیدی اضافه شده که می‌تواند به ابزارهای شخص‌ثالث (third party) همانند IDEها برای کنترل نوع داده‌ها در زمان توسعه برنامه یاری‌رسان باشد.
+
+باید توجه داشت که طبق سند PEP 484 پیروی از اصول Type Hints در پایتون اجباری نبوده و نخواهد شد. ولی Data Class یک استثناست و در آن حتما می‌بایست Attributeها به شیوه شرح داده شده، تعریف گردند.
+
+از آنجا که این نوع کلاس برای ایجاد یک کاربرد عمومی از کلاس‌ها توسعه یافته (نگهداری اطلاعات)، بنابراین بسیاری از عملیات‌ها در آن خودکارسازی شده تا پیاده‌سازی این کلاس ساده‌تر از هر کلاس دیگری باشد. برای مثال نیازی به پیاده‌سازی متد ``__init__`` نیست و این متد به صورت خودکار برای کلاس ما ایجاد می‌گردد. اکنون اگر بخواهیم دیتاکلاس مثال قبل را به صورت عادی پیاده‌سازی کنیم:
+
+
+.. code-block:: python
+    :linenos:
+
+    class Student:
+
+        def __init__(self, name, score):
+            self.name = name
+            self.score = score
+
+
+    student = Student('Saeid', 70)
+    print(student)
+    print('-' * 30)
+    print(student.name)
+    print(student.score)
+    print('-' * 30)
+    print(Student('Saeid', 70) == Student('Saeid', 70))
+
+::
+
+    <__main__.Student object at 0x7f922a311518>
+    ------------------------------
+    Saeid
+    70
+    ------------------------------
+    False
+
+
+با مقایسه این دو خروجی، مشاهده می‌شود که مقدار چاپ شی (سطر ۹) و نیز حاصل مقایسه دو شی (سطر ۱۴) با مقادیر یکسان متفاوت است. دلیل نیز پیشتر بیان شد،‌ تعدادی متد خاص همانند ``__init__`` برای دیتا کلاس‌ها پیاده‌سازی می‌شود که با پیاده‌سازی پیش‌فرض متفاوت‌ بوده و بر نوع کاربرد این کلاس‌ها و راحتی استفاده آن‌ها تمرکز شده است. این پیاده‌سازی را می‌توان به صورت زیر نمایش داد:
+
+
+
+.. code-block:: python
+    :linenos:
+
+    class Student:
+
+        def __init__(self, name, score):
+            self.name = name
+            self.score = score
+
+        def __str__(self):
+            return (f'{self.__class__.__name__}'
+                    f'(name={self.name!r}, score={self.score!r})')
+
+        def __eq__(self, other):
+            return (self.name, self.score) == (other.name, other.score)
+
+
+    student = Student('Saeid', 70)
+    print(student)
+    print('-' * 30)
+    print(student.name)
+    print(student.score)
+    print('-' * 30)
+    print(Student('Saeid', 70) == Student('Saeid', 70))
+
+::
+
+    Student(name='Saeid', score=70)
+    ------------------------------
+    Saeid
+    70
+    ------------------------------
+    True
+
+از درس پیش با متد ``__eq__`` آشنا هستیم، متد ``__str__`` [`اسناد پایتون <https://docs.python.org/3/reference/datamodel.html#object.__str__>`__] نیز یکی دیگر از متدهای خاص پایتون می‌باشد و هنگامی که یک شی می‌خواهد به نوع str تبدیل گردد، به صورت خودکار فراخوانی می‌گردد (**تبدیل به نوع رشته - درس هفتم**)، به صورت مشابه متد ``__repr__`` [`اسناد پایتون <https://docs.python.org/3/reference/datamodel.html#object.__repr__>`__] نیز قابل پیاده سازی است.
+
+
+متد ``__post_init__``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+دیتا کلاس‌ها همچنین می‌توانند شامل متد نیز باشند، چگونگی تعریف متد در دیتا کلاس تفاوتی با دیگر کلاس‌ها ندارد. 
+
+از طرفی می‌دانیم که متد ``__init__`` یک دیتا کلاس به صورت خودکار ایجاد می‌گردد و مرحله initialize شی از دستان ما خارج شده است. با این حال چنانچه اگر کلاس  شامل متدی با نام ``__post_init__`` باشد، این متد پس از ``__init__`` به صورت خودکار فراخوانی می‌گردد:
+
+.. code-block:: python
+    :linenos:
+
+    from dataclasses import dataclass
+
+    @dataclass
+    class Student:
+        name: str
+        score: int
+
+        def __post_init__(self):
+            print("__post_init__ got called:", self)
+            if self.name == 'Saeed':
+                self.name =  'Saeid'
+
+
+    student = Student('Saeed', 70)
+    print(student)
+
+::
+
+    __post_init__ got called: Student(name='Saeed', score=70)
+    Student(name='Saeid', score=70)
+
+
+
+از طریق ماژول ``dataclasses`` یک نوع یک annotation type جدید با نام ``InitVar`` در دسترس است. چنانچه در تعریف هر یک از Attributeها کلاس از این نوع استفاده کنیم، آن Attribute به عنوان پارامتر به متد ``__post_init__`` ارسال می‌گردد. باید توجه داشت که این نوع Attributeها به عنوان **Init-only variables** شناخته می‌شوند [`اسناد پایتون <https://docs.python.org/3/library/dataclasses.html#init-only-variables>`__] و مفسر پایتون آن‌ها را صرفا به ``__post_init__`` ارسال می‌کند و جزو فیلدهای دیتا کلاس قرار نمی‌دهد:
+
+
+.. code-block:: python
+    :linenos:
+
+
+    @dataclass
+    class Student:
+        name: InitVar[str]
+        score: int
+
+        def __post_init__(self, name):
+            if name == 'Saeid':
+                self.score =  100
+
+
+    student = Student('Saeid', 70)
+    print(student)
+
+
+::
+
+    Student(score=100)
+
+
+تابع ``fields``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+