الوحدة collections.abc‎ في بايثون

تقدّم هذه الوحدة مجموعة من الأصناف الأساسية المجرّدة abstract base calsses (يرمز لها ABC اختصارًا) والتي يمكن استخدامها للتأكد ممّا إذا كان صنف معيّن يقدّم واجهة interface معينة، كأن يكون الصنف قابلًا للتقطيع hashable أو أنّه صنف ربط mapping.

ملاحظة: قبل الإصدار 3.3 من اللغة كانت هذه الوحدة جزءًا من وحدة collections.

الأصناف الأساسية المجرّدة في الوحدة collections

تقدّم وحدة collections الأصناف الأساسية المجرّدة التالية:

الصنف الأساسي المجرد	يرث من	التوابع المجرّدة	توابع mixin
Container		__contains__
Hashable		__hash__
Iterable		__iter__
Iterator	Iterable	__next__	__iter__
Reversible	Iterable	__reversed__
Generator	Iterator	send، throw	close، __iter__، __next__‎
Sized		__len__
Callable		__call__
Collection	Sized،Iterable،Container	‎__‎contains__‎ ‎‎، ‎‎__iter__‎‎ ، ‎__len__‎‎‎‎
Sequence	Reversible،Collection	__getitem__،__len__	‎__contains__، __iter__، __reversed__، index، count
MutableSequence	Sequence	‎__getitem__ ‎،__setitem__، __delitem__، __len__،  insert	توابع Sequence الموروثة و append، reverse، extend، pop، remove، و __iadd__
ByteString	Sequence	__getitem__،__len__	توابع Sequence الموروثة
Set	Collection	‎__contains__ ،__iter__ ،__len __‎	‎__le__‎, ‎__lt__‎, ‎__eq__‎, ‎__ne__‎,‎__gt__‎, ‎__ge__‎, ‎__and__‎, ‎__or__‎,‎__sub__‎, ‎__xor__‎, isdisjoint
MutableSet	Set	‎__contains__ ، __iter__ ،__len__، add،discard	توابع Sequence الموروثة إضافة إلى التوابع clear، pop، remove، __ior__ ، __iand__ ،‎ __ixor‎__ ،  __isub__‎
Mapping	Collection	__getitem__،__iter__،__len__	‎‎__contains__، keys، items، values،get، ‎__eq__‎‎، and ‎__ne__‎
MutableMapping	Mapping	‎__getitem__، __setitem__ ،__delitem__ ،__iter__ ،__len__‎	توابع Mapping الموروثة و pop، popitem، clear، update، و setdefault
MappingView	Sized		__len__
ItemsView	MappingView،Set		__contains__، __iter__
KeysView	MappingView،Set		__contains__، __iter__
ValuesView	MappingView،Collection		__contains__، __iter__
Awaitable		__await__
Coroutine	Awaitable	send، throw	close
AsyncIterable		__aiter__
AsyncIterator	AsyncIterable	__anext__	__aiter__
AsyncGenerator	AsyncIterator	asend، athrow	aclose، __aiter__، __anext__‎

الصنف collections.abc.Sized

الصنف collections.abc.Callable

أصناف أساسية مجرّدة للأصناف التي تقدّم التوابع ‎__contains__()‎، ‎__hash__()‎، ‎__len__()‎ و ‎__call__()‎ على التوالي.

الصنف collections.abc.Iterable

صنف أساسي مجرّد للأصناف التي تقدّم التابع ‎__iter__()‎.

تؤدي عملية التحقّق بواسطة الدالة isinstance(obj، iterable)‎ إلى الكشف عن الأصناف المسجّلة على أنّها صنف Iterable الأساسي المجرّد أو أنّها تمتلك التابع ‎__iter__()‎، ولكنّها لا تكتشف الأصناف التي تجري عملية التكرار بواسطة التابع ‎__getitem__()‎. الطريقة الوحيدة لتحديد ما إذا كان الكائن قابلًا للتكرار هي استدعاء الدالة iter(obj)‎.

الصنف collections.abc.Collection

صنف أساسي مجرّد لأصناف الحاويات التكرارية المحجّمة (sized iterable container classes).

ملاحظة: هذا الصنف جديد في الإصدار 3.6 من بايثون.

الصنف collections.abc.Iterator

صنف أساسي مجرّد للأصناف التي تقدّم التابعين ‎__iter__()‎ و ‎__next__()‎‎.

الصنف collections.abc.Reversible

صنف أساسي مجرّد للأصناف التكرارية التي تقدّم التابع ‎__reversed__()‎.

ملاحظة: هذا الصنف جديد في الإصدار 3.6 من بايثون.

الصنف collections.abc.Generator

صنف أساسي مجرّد لإنشاء أصناف تستخدم البروتوكول المعرّف في PEP 342 والذي يضيف التوابع send()‎ و throw()‎ و close()‎ إلى المكرِّرات.

ملاحظة: هذا الصنف جديد في الإصدار 3.5 من بايثون.

الصنف collections.abc.ByteString

أصناف أساسية مجرّدة للتسلسلات التي تكون قابلة للتعديل mutable وللقراءة فقط read-only.

ملاحظة: بعض توابع mixin مثل ‎__iter__()‎ و ‎__reversed__()‎ و index()‎ تجري استدعاءات متكرّرة للتابع الضمني ‎__getitem__()‎. ونتيجة لذلك، إن كان التابع ‎__getitem__()‎ مُستخدمًا بسرعة وصول ثابتة، فإنّ أداء توابع mixin سيكون خطّيًا، ولكن إن كان التابع الضمني خطّيًا (كما هو الحال مع قائمة مرتبطة) فإنّ أداء توابع mixin سيكون تربيعيًا وهنا تظهر الحاجة إلى إعادة تعريفها.

ملاحظة: في الإصدار 3.5 أضيف المعاملان stop و start إلى التابع index()‎.

الصنف collections.abc.MutableSet

صنف أساسي مجرّد للمجموعات القابلة للتعديل والتي تكون للقراءة فقط.

الصنف collections.abc.MutableMapping

صنف أساسي مجرّد للمجموعات لكائنات الربط القابلة للتعديل والتي تكون للقراءة فقط.

الصنف collections.abc.ValuesView

أصناف أساسية مجرّد لعروض كائنات الربط والعناصر items والمفاتيح keys والقيم values.

الصنف collections.abc.Awaitable

صنف أساسي مجرّد لكائنات awaitable، والتي يمكن استخدامها في تعابير await. يجب أن يقدّم الاستخدام المخصّص لهذا الصنف التابع ‎__await__‎()‎.

كائنات Coroutine و نسخ الصنف الأساسي المجرّد Couroutine هي كلّها نسخ من هذا الصنف الأساسي المجرّد.

ملاحظة:

تكون الـ coroutines المستندة على المولدات في CPython (المولّدات المزخرفة بواسطة التابع types.coroutine()‎ أو asyncio.coroutine()‎) من نوع awaitable على الرغم من عدم احتوائها على التابع ‎__await__()‎. تعيد الدالة isinstance(gencoro، Awaitable)‎ القيمة False، ويجب استخدام التابع Useinspect.isawaitable()‎ للكشف عنها.

ملاحظة: هذا الصنف جديد في الإصدار 3.5 من بايثون.

الصنف collections.abc.Coroutine

صنف أساسي مجرّد للأصناف المتوافقة مع الـ coroutine. تستخدم هذه الأصناف التوابع send()‎ و throw()‎ و close()‎ والمعرّفة في كائنات Coroutine. إلى جانب ذلك يجب أن يتضمّن الاستخدام المخصّص لهذا الصنف الأساسي المجرد تضمين التابع ‎__await__()‎. جميع نسخ الصنف Coroutine هي نسخ للصنف Awaitable أيضًا.

ملاحظة:

تكون الـ coroutines المستندة على المولدات في CPython (المولّدات المزخرفة بواسطة التابع types.coroutine()‎ أو asyncio.coroutine()‎) من نوع awaitable على الرغم من عدم احتوائها على التابع ‎__await__()‎. تعيد الدالة isinstance(gencoro، Coroutine)‎ القيمة False، ويجب استخدام التابع Useinspect.isawaitable()‎ للكشف عنها.

ملاحظة: هذا الصنف جديد في الإصدار 3.5 من بايثون.

الصنف collections.abc.AsyncIterable

صنف أساسي مجرّد للأصناف التي تقدّم التابع ‎__aiter__‎.

ملاحظة: هذا الصنف جديد في الإصدار 3.5 من بايثون.

الصنف collections.abc.AsyncIterator

صنف أساسي مجرّد للأصناف التي تقدّم التابعين ‎__aiter__‎ و ‎__anext__‎.

ملاحظة: هذا الصنف جديد في الإصدار 3.5 من بايثون.

الصنف collections.abc.AsyncGenerator

صنف أساسي مجرّد للأصناف المولّدة غير المتزامنة asynchronous generator classes والتي تعتمد البروتوكول المعرف في PEP 525 و PEP 492.

ملاحظة: هذا الصنف جديد في الإصدار 3.6 من بايثون.

تتيح هذه الأصناف الأساسية المجرّد معرفةما إذا كانت الأصناف أو النسخ تقدّم وظيفة معيّنة، فعلى سبيل المثال:

size = None
if isinstance(myvar, collections.abc.Sized):
    size = len(myvar)

هناك عدد من الأصناف الأساسية المجرّدة التي يمكن الاستفادة منها كـ mixin تسهّل عملية تطوير أصناف تدعم الواجهات البرمجية الخاصة بالصنف الحاوي. فمثلًا، لكتابة صنف يدعم الواجهة البرمجية الكامل للصنف الأساسي المجرد Set، يكفي تزويد الصنف بالتوابع الضمنية المجرّدة التالية: ‎__contains__()‎ و ‎__iter__()‎ و ‎__len__()‎، ويزوّد الصنف الأساسي المجرد بقية التوابع مثل ‎‎__and__‎()‎ و isdisjoint()‎:

class ListBasedSet(collections.abc.Set):
    ''' Alternate set implementation favoring space over speed
        and not requiring the set elements to be hashable. '''
    def __init__(self, iterable):
        self.elements = lst = []
        for value in iterable:
            if value not in lst:
                lst.append(value)

    def __iter__(self):
        return iter(self.elements)

    def __contains__(self, value):
        return value in self.elements

    def __len__(self):
        return len(self.elements)

s1 = ListBasedSet('abcdef')
s2 = ListBasedSet('defghi')
overlap = s1 & s2            # مدعوم تلقائيًا ‎__and__()‎ التابع

ملاحظات على استخدام Set و MutableSet كـ mixin:

1. لمّا كانت بعض عمليات المجموعات تنشئ مجموعات جديدة فإنّ توابع mixin الافتراضية تكون بحاجة إلى إنشاء نسخ جديدة من المكرِّر. ويُفترض أن تتضمّن الدالة البانية للصنف توقيعًا بالصيغةClassName(iterable)‎. يجري تحليل ذلك الافتراض إلى تابع صنف داخلي يدعى ‎_from_iterable()‎ والذي يستدعي الدالة cls(iterable)‎ لإنشاء مجموعة جديدة. إن استخدم Set mixin في صنف ذي توقع مختلف في دالته البانية، فيجب إعادة تعريف override التابع ‎_from_iterable()‎ بتابع صنف يمكنه بناء نسخ جديد من معامل مكرِّر iterable argument.
2. لإعادة تعريف عمليات المقارنة (لأغراض السرعة على الأرجح وذلك لأنّها عمليات ثابتة) يجب إعادة تعريف التابعين ‎__le__‎()‎ و ‎__ge__()‎ وستتبع بقية العمليات هذين التابعين بصورة تلقائية.
3. يقدّم Set mixin تابع ‎_hash()‎ لحساب قيمة hash للمجموعة، ولكن لا يجري تعريف التابع ‎__hash__()‎ لأنّ جميع المجموعات تكون قابلة للتقطيع hashable أو غير قابلة للتعديل immutable. ولإضافة قابلية التقطيع باستخدام mixins، يمكن الوراثة من الصنفين Set()‎ و Hashable()‎ ثم تعريف القيمة ‎__hash__ ‎ = Set._hash.

انظر أيضًا

• وحدة collections في بايثون.

مصادر

• صفحة Abstract Base Classes for Containers في توثيق بايثون الرسمي.