Есть ли официальный или общеизвестный стандарт минимального интерфейса для объекта «списка»?

Question

Я продолжаю видеть функции и документацию, как this и this(назвать несколько) которые работают или обратитесь к список подобных объектов.

Я вполне осознает, что именно фактический список (dir(list)), и может вывести, что (часто варьируя) методы из списка необходимы в большинстве ссылок на «список подобных объектов», однако сколько раз я вижу ссылку на нее, оставил мне следующий вопрос:

Есть ли стандартный или минимальный интерфейс для стандартного минимального интерфейса для «списка»? Проще как актуализировать __getitem__, или согласен, что необходимы дополнительные вещи, такие как __len__ и __setitem__?

Это может показаться семантикой, но я не могу не подумать, что если не существует стандартного минимального требования к интерфейсу, различные идеи "list-likeness" могут вызвать некоторые проблемы/неправильную обработку. Может быть, это всего лишь небольшая минута для печатания утиных питов?

Answer 1

См. Модуль collections.abc. Из приведенных там абстрактных базовых классов list в Python реализует Iterable, Container, Sized, Sequence и MutableSequence. Теперь из них Iterable, Sequence и MutableSequence можно было случайно назвать list-like.

Однако, я понимаю этот термин список подобных означает, что это MutableSequence - имеет, по крайней мере, методы __getitem__, __setitem__, __delitem__ и __len__, ожидающие также его иметь методы подмешать, указанные в документации, таких как append.

Если нет необходимости в __setitem__ и __delitem__ следует назвать последовательность вместо этого - предположение, что если что-то принимает последовательность, он не должен быть изменяемым, таким образом str, bytes, tuple и т.д. также работать там.

---

Ваши две ссылки подчеркивают расплывчатость термина:

plotly API требует, чтобы list-like объекты будут упорядочены в массив JSON внутренним PlotlyJSONEncoder, что делегаты большинства из кодировки на Python JSONEncoder , Однако последний кодирует только tuple и list (и подклассы) в массив JSON; таким образом, список здесь означает list, tuple или их подклассы. Пользовательский объект последовательности, который не является подклассом, приведет к TypeError: [...] is not JSON serializable.

unzip recipe вы связаны требует объект, который ведет себя как Sequence (Изменчивость не требуется), таким образом, tuplestr или, или любой пользовательский объект, реализующий Sequence там будут делать.

---

TL; DR список подобных является расплывчатым термином. Предпочтительно использовать термины итеративная, последовательность и изменяемая последовательность, теперь, когда они определены в collections.abc.

Answer 2

Технический термин для «списка объектов» - . Последовательность. По крайней мере, он поддерживает упорядочение (т. Е. Два объекта с одинаковыми элементами, но разные порядки не равны), индексирование (foo[bar] такое, что bar является целым числом, меньшим длины последовательности) и проверок локализации (in), и имеет заданной длины. Это должно поддержка итерации, но если нет, то Python будет имитировать ее с помощью индексации.

Answer 3

Практически каждый раз, когда вы видите «-подобный объект» в документации на Python, автор сознательно расплывчато. Автор решил, что перечисление всех необходимых интерфейсов будет слишком сложным, и говорит только о том, что некоторые из его интерфейсов требуются. Объект, который реализовал все интерфейсы, гарантированно работает, но в большинстве случаев он будет работать с объектом, который реализует гораздо меньше.

С помощью «списка, подобного объекту», возможно, лучшее, что вы можете сделать, помимо проверки исходного кода, заключается в том, чтобы определить, нужен ли ему какой-либо из изменяемых интерфейсов. Если ему нужен только доступ только для чтения к списку, вы можете быть уверены, что вам не нужно выполнять какие-либо операции с изменяемой последовательностью.

Если он говорит «объект, похожий на список или итератор», вы можете предоставить что-то, что реализует гораздо более простой интерфейс итератора.