From b32bcafe5007192e7f1c0d1259dda3b11b9eb1d7 Mon Sep 17 00:00:00 2001 From: Alexandre Figura Date: Fri, 29 Dec 2017 17:28:58 +0100 Subject: [PATCH] Document all_records attribute of class LDIFRecordList The current documentation of this attribute was not displayed on the online doc. --- Lib/ldif.py | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/Lib/ldif.py b/Lib/ldif.py index a9ece64..96b1651 100644 --- a/Lib/ldif.py +++ b/Lib/ldif.py @@ -577,8 +577,10 @@ def parse_change_records(self): class LDIFRecordList(LDIFParser): """ - Collect all records of LDIF input into a single list. - of 2-tuples (dn,entry). It can be a memory hog! + Collect all records of a LDIF file. It can be a memory hog! + + Records are stored in :attr:`.all_records` as a single list + of 2-tuples (dn, entry), after calling :meth:`.parse`. """ def __init__( @@ -586,20 +588,15 @@ def __init__( input_file, ignored_attr_types=None,max_entries=0,process_url_schemes=None ): - """ - See LDIFParser.__init__() - - Additional Parameters: - all_records - List instance for storing parsed records - """ LDIFParser.__init__(self,input_file,ignored_attr_types,max_entries,process_url_schemes) + + #: List storing parsed records. self.all_records = [] self.all_modify_changes = [] def handle(self,dn,entry): """ - Append single record to dictionary of all records. + Append a single record to the list of all records (:attr:`.all_records`). """ self.all_records.append((dn,entry))