l17: add hashable objects

Author: Saeid Darvish

lessons/l17.rst

@@ -1,7 +1,7 @@
 .. role:: emoji-size
 
 .. meta::
-   :description: کتاب آموزش زبان برنامه نویسی پایتون به فارسی، آموزش شی گرایی در پایتون، تعریف کلاس در پایتون، معرفی ساختار کلاس در پایتون، تعریف متد Method و صفت Attribute در کلاس‌های پایتون، معرفی Constructor در کلاس پایتون، ایجاد شی و نمونه سازی در پایتون، OOP در پایتون
+   :description: کتاب آموزش زبان برنامه نویسی پایتون به فارسی، آموزش شی گرایی در پایتون، تعریف کلاس در پایتون، معرفی ساختار کلاس در پایتون، تعریف متد Method و صفت Attribute در کلاس‌های پایتون، معرفی Constructor در کلاس پایتون، ایجاد شی و نمونه سازی در پایتون، OOP در پایتون، شی hashable در پایتون، hash در پایتون، مقایسه دو شی در پایتون
    :keywords:  آموزش, آموزش پایتون, آموزش برنامه نویسی, پایتون, تابع, کتابخانه, پایتون, شی گرایی در پایتون
 
 
@@ -630,6 +630,155 @@ Class Attribute
   این نوع متد (Static Method) را می‌توان هم با استفاده از نام کلاس دستیابی کرد (سطر ۱۷) و هم با استفاده از اشیای آن کلاس (سطر ۱۹)، در واقع دکوراتور  ``staticmethod@`` کارهای لازم برای نادیده گرفتن شی و کلاس مربوط را انجام می‌دهد.
 
 
+مقدار Hash یک شی و کاربرد آن در پایتون
+---------------------------------------------
+
+به صورت کلی یک **Hash** در واقع عددی است که در ازای داده‌ای مشخص برآورد می‌گردد. داده‌های مشابه دارای مقدار hash یکسانی خواهند بود و از طرفی یک تغییر جزئی در داده منجر به تولید یک مقدار hash کاملا متفاوت می‌شود. مقدار hash از یک تابع هَش [`ویکی‌پدیا <https://en.wikipedia.org/wiki/Hash_function>`__] به دست می‌آید که مسئولیت آن تبدیل داده ورودی به hash رمزگذاری شده است. واضح است که تعداد داده‌ها می‌تواند بسیار بیشتر از تعداد مقادیر قابل تولید hash باشد، بنابراین دو داده ممکن است مقدار hash یکسان داشته باشند که به آن Hash collision می‌گویند. در واقع اگر دو شی hash یکسان داشته باشند، لزوماً دارای ارزش یکسانی نیستند (برابر نیستند).
+
+
+در زبان برنامه‌نویسی پایتون،‌ تابع ``hash`` [`اسناد پایتون <https://docs.python.org/3/library/functions.html#hash>`__] یک شی hashable (قابل hash) را دریافت و مقدار hash آن را بر می‌گرداند::
+
+    >>> a = 5
+    >>> hash(a)
+    5
+    >>> hash(5)
+    5
+
+    >>> hash(999999999999999999)
+    999999999999999999
+    >>> hash(99999999999999999999999999999999999999)
+    244469275760665570
+
+    >>> a = 'saeid'
+    >>> hash(a)
+    4007074958086188072
+
+    >>> hash('PYTHON')
+    -6387242471900568301
+
+    >>> hash('PYTHoN')
+    -6457932607787762593
+
+
+* گاهی ممکن است مقدار hash برابر با یک عدد منفی محاسبه گردد، مقدار hash منفی نیز در پایتون معتبر می‌باشد.
+
+* با دوباره اجرا کردن برنامه یا اسکریپت ممکن است به نتایج دیگری از مقدار hash برسید. در واقع تظمین یکتایی مقدار hash تولید شده در پایتون تنها در ازای حیات هر proccess یا «اجرای برنامه» پابرجا خواهد بود.
+
+
+شی hashable
+~~~~~~~~~~~~~~~~~~~~~
+
+گفتیم ورودی تابع ``hash`` پایتون می‌بایست یک شی hashable باید. **کدام اشیا در پایتون hashable هستند؟** تمامی اشیای که از نوع immutable (تغییرناپذیر - *مراجعه شود به بخش دسته‌بندی از درس هشتم*) هستند و همچنین اشیایی که متد خاص ``__hash__`` [`اسناد پایتون <https://docs.python.org/3/reference/datamodel.html#object.__hash__>`__] را پیاده‌سازی کرده باشند::
+
+
+    >>> class Sample:
+    ...     pass
+    ... 
+    >>> obj = Sample()
+    >>> hash(obj)
+    -9223363243335467036
+    >>> obj.__hash__()
+    -9223363243335467036
+
+متد ``__hash__`` جزو متدهای خاص در پایتون می‌باشد و هر کلاسی که در پایتون ایجاد می‌کنید به صورت ضمنی یک پیاده‌سازی پیش‌فرض از این متد را شامل می‌شود.
+
+
+کاربرد hash در پایتون
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**۱) ساختار Hash table** [`ویکی‌پدیا <https://en.wikipedia.org/wiki/Hash_table>`__]
+
+ساختمان داده دو نوع **دیکشنری (dict)** و **مجموعه (set)** در زبان برنامه‌نویسی پایتون بر پایه Hash table ایجاد شده است. در نتیجه سرعت دستیابی عناصر در آن‌ها بسیار بیشتر از دستیابی در شی لیست (List) می‌باشد. در نوع داده دیکشنری، hash کلیدها محاسبه و از آن برای دستیابی مقدار مربوطه استفاده می‌شود، برای همین است که **کلیدها در دیکشنری حتما می‌بایست از نوع hashable باشند** ولی برای مقادیر هیچ محدودیتی وجود ندارد. نوع داده مجموعه نیز **تنها می‌تواند شامل تعدادی شی hashable و یکتا (غیر تکراری) باشد**.
+
+
+**۲) مقایسه دو شی**
+
+
+
+.. tip:: 
+
+  * اگر دو شی با یکدیگر برابر باشند، آنگاه مقدار hash آن‌ها نیز برابر خواهد بود.
+
+  * اگر مقدار hash دو شی با یکدیگر برابر باشد، آنگاه **ممکن است** آن دو شی نیز با یکدیگر برابر باشند.
+
+
+
+طی دروس آینده با مبحث Operator Overloading آشنا خواهید شد ولی در اینجا تنها کافی است بدانید که هرگاه دو شی توسط عملگر ``==`` مقایسه گردند، متد ``__eq__`` [`اسناد پایتون <https://docs.python.org/3/reference/datamodel.html#object.__eq__>`__] به صورت خودکار فراخوانی خواهد شد. البته این متد نیز مانند باقی متدهای خاص پایتون، به صورت ضمنی یک پیاده‌سازی پیش‌فرض از خود دارد. در واقع خروجی این متد نتیجه مقایسه برابر بودن دو شی را برمی‌گرداند.
+
+بین دو متد ``__eq__`` و ``__hash__`` روابطی حاکم است که باید بدانیم:
+
+
+* اگر متد ``__eq__`` را پیاده‌سازی کنید ولی متد ``__hash__`` را خیر، **آنگاه اشیای کلاس مذکور hashable نخواهند بود**.
+
+* اگر متد ``__hash__`` را پیاده‌سازی کرده‌اید، آنگاه بهتر است متد ``__eq__`` را هم پیاده‌سازی نمایید. در غیر این صورت ممکن است در هنگام مقایسه اشیا خود دچار نتایج نامطلوب گردید. 
+
+* در حالت پیش‌فرض پایتون، ``True`` بودن خروجی متد ``__eq__`` برای دو شی ``x`` و ``y`` یعنی ``x == y`` به معنی برقرار بودن دو شرط:‌ ``x is y`` و ``hash(x) == hash(y)`` می‌باشد.
+
+* در حالت پیش‌فرض پایتون، تمام اشیای یک کلاس نابرابر و دارای مقدار hash متفاوت هستند، مگر اینکه ملاک مقایسه یک شی، خودش باشد.
+
+به دو نمونه کد زیر توجه نمایید:
+
+
+**مقایسه شی در حالت پیش‌فرض:**
+
+.. code-block:: python
+    :linenos:
+
+    class Student:
+        def __init__(self, name, score):
+            self.name = name
+            self.score = score
+
+    obj_1 = Student('Saeid', 70)
+    obj_2 = Student('Saeid', 90)
+
+    print('Single Object     :', obj_1 == obj_1)
+    print('Same Objects      :', obj_1 == Student('Saeid', 70))
+    print('Different Objects :', obj_1 == obj_2) 
+
+
+::
+
+    Single Object     : True
+    Same Objects      : False
+    Different Objects : False
+
+
+
+**مقایسه شی به همراه شخصی‌سازی دو متد مذکور:**
+
+
+.. code-block:: python
+    :linenos:
+
+    class Student:
+        def __init__(self, name, score):
+            self.name = name
+            self.score = score
+
+        def __eq__(self, other):
+            return self.name == other.name and self.score == other.score
+
+        def __hash__(self):
+            return hash((self.name, self.score))
+
+    obj_1 = Student('Saeid', 70)
+    obj_2 = Student('Saeid', 90)
+
+    print('Single Object     :', obj_1 == obj_1)
+    print('Same Objects      :', obj_1 == Student('Saeid', 70))
+    print('Different Objects :', obj_1 == obj_2)
+
+::
+
+    Single Object     : True
+    Same Objects      : True
+    Different Objects : False
+
+
+در این مثال هر دو Attribute کلاس Student از نوع immutable بودند، بنابراین از خود آن‌ها برای مقایسه و محاسبه مقدار hash استفاده کردیم. به هر حال منطق پیاده‌سازی این دو متد بر اساس مسئله مطرح شده، بر عهده برنامه‌نویس می‌باشد. حتی می‌توانید از مقدار تابع ``()id`` یا همان ``id(self)`` بهره بگیرید.
+
+
 
 |