Add various import, spacing and nomenclature fixes in different parts of the codebase.

Author: acsor

README.md

@@ -14,7 +14,7 @@ for better ongoing support to start in August 2018.
 Homepage (available soon): http://claird.github.io/PyPDF4/.
 
 ## Examples
-Please see the `samplecode` folder.
+Please see the `samplecode/` folder.
 
 ## Documentation
 Documentation soon will be available, although probably not at

pypdf4/__init__.py

@@ -1,5 +1,6 @@
 from pypdf4.pdf import PdfFileReader, PdfFileWriter
 from pypdf4.merger import PdfFileMerger
+from pypdf4.pagerange import PageRange
 from pypdf4._version import __version__
 
-__all__ = ["PdfFileReader", "PdfFileWriter", "PdfFileMerger"]
+__all__ = ["PdfFileReader", "PdfFileWriter", "PdfFileMerger", "PageRange"]

pypdf4/filters.py

@@ -489,7 +489,7 @@ def encode(data, decodeParms=None):
         return LZWCodec.Encoder(data).encode()
 
     @staticmethod
-    def decode(data, decode_params=None):
+    def decode(data, decodeParms=None):
         return LZWCodec.Decoder(data).decode()
 
 
@@ -552,9 +552,8 @@ def decode(data, decodeParms=None):
 
         :param data: a str or bytes sequence of ASCII85-encoded characters.
         :return: bytes for Python 3, str for Python 2.
-
-        TO-DO Add check for missing '~>' EOD marker.
         """
+        # TO-DO Add check for missing '~>' EOD marker.
         group_index = b = 0
         out = bytearray()
 
@@ -602,7 +601,7 @@ def encode(data, decodeParms=None):
         raise NotImplementedError()
 
     @staticmethod
-    def decode(data, decode_params=None):
+    def decode(data, decodeParms=None):
         """
         TO-DO Implement this filter.
         """

pypdf4/generic.py

@@ -37,9 +37,10 @@
 
 from . import filters
 from . import utils
-from .utils import PdfStreamError
-from .utils import pypdfBytes as b_, pypdfUnicode as u_, pypdfChr, pypdfOrd
-from .utils import readNonWhitespace, RC4Encrypt, skipOverComment
+from pypdf4.utils import PdfStreamError
+from pypdf4.utils import pypdfBytes as b_, pypdfUnicode as u_, pypdfChr,\
+        pypdfOrd
+from pypdf4.utils import readNonWhitespace, RC4Encrypt, skipOverComment
 
 
 __author__ = "Mathieu Fenniak"
@@ -100,6 +101,7 @@ def getObject(self):
         return self
 
 
+# TO-DO Add __repr_() implementations to the *Object classes
 class NullObject(PdfObject):
     def writeToStream(self, stream, encryption_key):
         stream.write(b_("null"))

pypdf4/pagerange.py

@@ -9,7 +9,7 @@
 
 import re
 
-from .utils import isString
+from pypdf4.utils import isString
 
 _INT_RE = r"(0|-?[1-9]\d*)"  # A decimal int, don't allow "-0".
 PAGE_RANGE_RE = "^({int}|({int}?(:{int}?(:{int}?)?)))$".format(int=_INT_RE)
@@ -89,12 +89,10 @@ def __init__(self, arg):
             __init__.__doc__.format(page_range_help=PAGE_RANGE_HELP)
 
     @staticmethod
-    def valid(input_value):
+    def valid(input):
         """ True if input is a valid initializer for a PageRange. """
-        return isinstance(input_value, slice) or \
-               isinstance(input_value, PageRange) or \
-               (isString(input_value)
-                and bool(re.match(PAGE_RANGE_RE, input_value)))
+        return isinstance(input, slice) or isinstance(input, PageRange) or\
+               (isString(input) and bool(re.match(PAGE_RANGE_RE, input)))
 
     def toSlice(self):
         """ Return the slice equivalent of this page range. """

pypdf4/xmp.py

@@ -100,10 +100,10 @@ def _getText(self, element):
 
         return text
 
-    def _converter_string(value):
+    def _converterString(value):
         return value
 
-    def _converter_date(value):
+    def _converterDate(value):
         m = iso8601.match(value)
         year = int(m.group("year"))
         month = int(m.group("month") or "1")
@@ -127,9 +127,9 @@ def _converter_date(value):
 
         return dt
 
-    _test_converter_date = staticmethod(_converter_date)
+    _test_converter_date = staticmethod(_converterDate)
 
-    def _getter_bag(namespace, name, converter):
+    def _getterBag(namespace, name, converter):
         def get(self):
             cached = self.cache.get(namespace, {}).get(name)
             retval = []
@@ -156,7 +156,7 @@ def get(self):
 
         return get
 
-    def _getter_seq(namespace, name, converter):
+    def _getterSeq(namespace, name, converter):
         def get(self):
             cached = self.cache.get(namespace, {}).get(name)
             retval = []
@@ -186,7 +186,7 @@ def get(self):
 
         return get
 
-    def _getter_langalt(namespace, name, converter):
+    def _getterLangalt(namespace, name, converter):
         def get(self):
             cached = self.cache.get(namespace, {}).get(name)
             retval = {}
@@ -213,7 +213,7 @@ def get(self):
 
         return get
 
-    def _getter_single(namespace, name, converter):
+    def _getterSingle(namespace, name, converter):
         def get(self):
             cached = self.cache.get(namespace, {}).get(name)
 
@@ -240,174 +240,174 @@ def get(self):
         return get
 
     dc_contributor = property(
-        _getter_bag(DC_NAMESPACE, "contributor", _converter_string)
+        _getterBag(DC_NAMESPACE, "contributor", _converterString)
     )
     """
     Contributors to the resource (other than the authors). An unsorted array of
     names.
     """
 
     dc_coverage = property(
-        _getter_single(DC_NAMESPACE, "coverage", _converter_string)
+        _getterSingle(DC_NAMESPACE, "coverage", _converterString)
     )
     """
     Text describing the extent or scope of the resource.
     """
 
     dc_creator = property(
-        _getter_seq(DC_NAMESPACE, "creator", _converter_string)
+        _getterSeq(DC_NAMESPACE, "creator", _converterString)
     )
     """
     A sorted array of names of the authors of the resource, listed in order of
     precedence.
     """
 
-    dc_date = property(_getter_seq(DC_NAMESPACE, "date", _converter_date))
+    dc_date = property(_getterSeq(DC_NAMESPACE, "date", _converterDate))
     """
     A sorted array of dates (``datetime.datetime`` instances) of significance
     to the resource.  The dates and times are in UTC.
     """
 
     dc_description = property(
-        _getter_langalt(DC_NAMESPACE, "description", _converter_string)
+        _getterLangalt(DC_NAMESPACE, "description", _converterString)
     )
     """
     A language-keyed dictionary of textual descriptions of the content of the
     resource.
     """
 
     dc_format = property(
-        _getter_single(DC_NAMESPACE, "format", _converter_string)
+        _getterSingle(DC_NAMESPACE, "format", _converterString)
     )
     """
     The mime-type of the resource.
     """
 
     dc_identifier = property(
-        _getter_single(DC_NAMESPACE, "identifier", _converter_string)
+        _getterSingle(DC_NAMESPACE, "identifier", _converterString)
     )
     """
     Unique identifier of the resource.
     """
 
     dc_language = property(
-        _getter_bag(DC_NAMESPACE, "language", _converter_string)
+        _getterBag(DC_NAMESPACE, "language", _converterString)
     )
     """
     An unordered array specifying the languages used in the resource.
     """
 
     dc_publisher = property(
-        _getter_bag(DC_NAMESPACE, "publisher", _converter_string)
+        _getterBag(DC_NAMESPACE, "publisher", _converterString)
     )
     """
     An unordered array of publisher names.
     """
 
     dc_relation = property(
-        _getter_bag(DC_NAMESPACE, "relation", _converter_string)
+        _getterBag(DC_NAMESPACE, "relation", _converterString)
     )
     """
     An unordered array of text descriptions of relationships to other
     documents.
     """
 
     dc_rights = property(
-        _getter_langalt(DC_NAMESPACE, "rights", _converter_string)
+        _getterLangalt(DC_NAMESPACE, "rights", _converterString)
     )
     """
     A language-keyed dictionary of textual descriptions of the rights the user
     has to this resource.
     """
 
     dc_source = property(
-        _getter_single(DC_NAMESPACE, "source", _converter_string)
+        _getterSingle(DC_NAMESPACE, "source", _converterString)
     )
     """
     Unique identifier of the work from which this resource was derived.
     """
 
     dc_subject = property(
-        _getter_bag(DC_NAMESPACE, "subject", _converter_string)
+        _getterBag(DC_NAMESPACE, "subject", _converterString)
     )
     """
     An unordered array of descriptive phrases or keywrods that specify the
     topic of the content of the resource.
     """
 
     dc_title = property(
-        _getter_langalt(DC_NAMESPACE, "title", _converter_string)
+        _getterLangalt(DC_NAMESPACE, "title", _converterString)
     )
     """
     A language-keyed dictionary of the title of the resource.
     """
 
-    dc_type = property(_getter_bag(DC_NAMESPACE, "type", _converter_string))
+    dc_type = property(_getterBag(DC_NAMESPACE, "type", _converterString))
     """
     An unordered array of textual descriptions of the document type.
     """
 
     pdf_keywords = property(
-        _getter_single(PDF_NAMESPACE, "Keywords", _converter_string)
+        _getterSingle(PDF_NAMESPACE, "Keywords", _converterString)
     )
     """
     An unformatted text string representing document keywords.
     """
 
     pdf_pdfversion = property(
-        _getter_single(PDF_NAMESPACE, "PDFVersion", _converter_string)
+        _getterSingle(PDF_NAMESPACE, "PDFVersion", _converterString)
     )
     """
     The PDF file version, for example ``1.0``, ``1.3``.
     """
 
     pdf_producer = property(
-        _getter_single(PDF_NAMESPACE, "Producer", _converter_string)
+        _getterSingle(PDF_NAMESPACE, "Producer", _converterString)
     )
     """
     The name of the tool that created the PDF document.
     """
 
     xmp_createDate = property(
-        _getter_single(XMP_NAMESPACE, "CreateDate", _converter_date)
+        _getterSingle(XMP_NAMESPACE, "CreateDate", _converterDate)
     )
     """
     The date and time the resource was originally created.  The date and time
     are returned as a UTC ``datetime.datetime`` object.
     """
 
     xmp_modifyDate = property(
-        _getter_single(XMP_NAMESPACE, "ModifyDate", _converter_date)
+        _getterSingle(XMP_NAMESPACE, "ModifyDate", _converterDate)
     )
     """
     The date and time the resource was last modified.  The date and time are
     returned as a UTC ``datetime.datetime`` object.
     """
 
     xmp_metadataDate = property(
-        _getter_single(XMP_NAMESPACE, "MetadataDate", _converter_date)
+        _getterSingle(XMP_NAMESPACE, "MetadataDate", _converterDate)
     )
     """
     The date and time that any metadata for this resource was last changed. The
     date and time are returned as a UTC ``datetime.datetime`` object.
     """
 
     xmp_creatorTool = property(
-        _getter_single(XMP_NAMESPACE, "CreatorTool", _converter_string)
+        _getterSingle(XMP_NAMESPACE, "CreatorTool", _converterString)
     )
     """
     The name of the first known tool used to create the resource.
     """
 
     xmpmm_documentId = property(
-        _getter_single(XMPMM_NAMESPACE, "DocumentID", _converter_string)
+        _getterSingle(XMPMM_NAMESPACE, "DocumentID", _converterString)
     )
     """
     The common identifier for all versions and renditions of this resource.
     """
 
     xmpmm_instanceId = property(
-        _getter_single(XMPMM_NAMESPACE, "InstanceID", _converter_string)
+        _getterSingle(XMPMM_NAMESPACE, "InstanceID", _converterString)
     )
     """
     An identifier for a specific incarnation of a document, updated each time a

samplecode/basic_features.py

@@ -100,5 +100,6 @@ def main():
 
     print("Output successfully written to", output)
 
+
 if __name__ == "__main__":
     main()