Pylint for test folder (#94)

Author: fbernhart

.github/workflows/continuous-integration-workflow.yml

@@ -28,7 +28,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install . -r test/requirements.txt -r docs/requirements.txt
       - name: Statically checking code 🔎
-        run: pylint fpdf
+        run: pylint fpdf test
       - name: Ensure code has been autoformatted with black 🖌️
         run: black --check .
       - name: Checking all PDF samples ☑

.pylintrc

@@ -1,6 +1,6 @@
 [MESSAGES CONTROL]
-disable = attribute-defined-outside-init, blacklisted-name, fixme, invalid-name, method-hidden, missing-docstring, multiple-imports, too-few-public-methods, too-many-arguments, too-many-instance-attributes, too-many-nested-blocks, too-many-branches, too-many-lines, too-many-locals, too-many-public-methods, too-many-statements, wrong-import-order, wrong-import-position
-max-line-length = 180
+disable = attribute-defined-outside-init, blacklisted-name, fixme, invalid-name, method-hidden, missing-docstring, too-few-public-methods, too-many-arguments, too-many-instance-attributes, too-many-nested-blocks, too-many-branches, too-many-lines, too-many-locals, too-many-public-methods, too-many-statements, wrong-import-order
+max-line-length=88
 
 [SIMILARITIES]
 # Restricting duplicate-code check:

fpdf/fpdf.py

@@ -781,7 +781,8 @@ def rotate(self, angle, x=None, y=None):
           Use `rotation` instead.
         """
         warnings.warn(
-            "rotate() can produces malformed PDFs and is deprecated. Use the rotation() context manager instead.",
+            "rotate() can produces malformed PDFs and is deprecated. "
+            "Use the rotation() context manager instead.",
             PendingDeprecationWarning,
         )
         if x is None:
@@ -816,8 +817,8 @@ def rotation(self, angle, x=None, y=None):
         Notes
         -----
 
-        Only the rendering is altered. The `get_x()` and `get_y()` methods are not affected,
-        nor the automatic page break mechanism.
+        Only the rendering is altered. The `get_x()` and `get_y()` methods are not
+        affected, nor the automatic page break mechanism.
         """
         if x is None:
             x = self.x
@@ -850,12 +851,13 @@ def cell(self, w, h=0, txt="", border=0, ln=0, align="", fill=False, link=""):
             txt (str): String to print. Default value: empty string.
             border: Indicates if borders must be drawn around the cell.
                 The value can be either a number (`0`: no border ; `1`: frame)
-                or a string containing some or all of the following characters (in any order):
+                or a string containing some or all of the following characters
+                (in any order):
                 `L`: left ; `T`: top ; `R`: right ; `B`: bottom. Default value: 0.
             ln (int): Indicates where the current position should go after the call.
-                Possible values are: `0`: to the right ; `1`: to the beginning of the next line ;
-                `2`: below. Putting 1 is equivalent to putting 0 and calling `ln` just after.
-                Default value: 0.
+                Possible values are: `0`: to the right ; `1`: to the beginning of the
+                next line ; `2`: below. Putting 1 is equivalent to putting 0 and calling
+                `ln` just after. Default value: 0.
             align (str): Allows to center or align the text. Possible values are:
                 `L` or empty string: left align (default value) ; `C`: center ;
                 `R`: right align
@@ -869,7 +871,8 @@ def cell(self, w, h=0, txt="", border=0, ln=0, align="", fill=False, link=""):
             raise FPDFException("No font set, you need to call set_font() beforehand")
         if isinstance(border, int) and border not in (0, 1):
             warnings.warn(
-                'Integer values for "border" parameter other than 1 are currently ignored'
+                'Integer values for "border" parameter other than 1 are currently '
+                "ignored"
             )
             border = 1
         page_break_triggered = False
@@ -1026,31 +1029,34 @@ def multi_cell(
         max_line_height=None,
     ):
         """
-        Output text with line breaks, cf. https://pyfpdf.github.io/fpdf2/reference/multi_cell.html
+        Output text with line breaks, cf.
+        https://pyfpdf.github.io/fpdf2/reference/multi_cell.html
 
         Args:
             w (int): cells width. If 0, they extend up to the right margin of the page.
             h (int): cells height.
             txt (str): strign to print.
             border: Indicates if borders must be drawn around the cell.
                 The value can be either a number (`0`: no border ; `1`: frame)
-                or a string containing some or all of the following characters (in any order):
+                or a string containing some or all of the following characters
+                (in any order):
                 `L`: left ; `T`: top ; `R`: right ; `B`: bottom. Default value: 0.
             align (str): Allows to center or align the text. Possible values are:
                 `L` or empty string: left align (default value) ; `C`: center ;
                 `R`: right align
             fill (bool): Indicates if the cell background must be painted (`True`)
                 or transparent (`False`). Default value: False.
-            split_only (bool): if `True`, does not output anything, only perform word-wrapping
-                and return the resulting multi-lines array of strings.
+            split_only (bool): if `True`, does not output anything, only perform
+                word-wrapping and return the resulting multi-lines array of strings.
             link (str): optional link to add
             ln (int): Indicates where the current position should go after the call.
-                Possible values are: `0`: to the bottom right ; `1`: to the beginning of the next line ;
-                `2`: below with the same horizontal offset ; `3`: to the right with the same vertical offset.
-                Default value: 0.
+                Possible values are: `0`: to the bottom right ; `1`: to the beginning
+                of the next line ; `2`: below with the same horizontal offset ;
+                `3`: to the right with the same vertical offset. Default value: 0.
             max_line_height (int): optional maximum height of each sub-cell generated
 
-        Using `ln=3` and `maximum height=pdf.font_size` is useful to build tables with multiline text in cells.
+        Using `ln=3` and `maximum height=pdf.font_size` is useful to build tables
+        with multiline text in cells.
 
         Returns: a boolean indicating if page break was triggered.
         """
@@ -1330,7 +1336,8 @@ def image(
         Put an image on the page
 
         Args:
-            name: either a string representing a file path to an image, or a instance of `PIL.Image.Image`
+            name: either a string representing a file path to an image, or a instance of
+            `PIL.Image.Image`
             x (int): optional horizontal position where to put the image on the page
             y (int): optional vertical position where to put the image on the page
             w (int): optional width of the image
@@ -1395,7 +1402,8 @@ def image(
     def ln(self, h=None):
         """
         Line Feed.
-        The current abscissa goes back to the left margin and the ordinate increases by the amount passed as parameter.
+        The current abscissa goes back to the left margin and the ordinate increases by
+        the amount passed as parameter.
 
         Args:
             h (int): The height of the break.

fpdf/html.py

@@ -32,7 +32,8 @@ def __init__(self, pdf, image_map=None, table_line_separators=False):
         """
         Args:
             pdf (FPDF): an instance of `fpdf.FPDF`
-            image_map (function): an optional one-argument function that map <img> "src" to new image URLs
+            image_map (function): an optional one-argument function that map <img> "src"
+                to new image URLs
             table_line_separators (bool): enable horizontal line separators in <table>
         """
         super().__init__()

fpdf/template.py

@@ -155,8 +155,8 @@ def split_multicell(self, text, element_name):
     def render(self, outfile=None, dest=None):
         """
         Args:
-            outfile (str): optional output PDF file path.
-                If ommited, the `.pdf.output(...)` method can be manuallyy called afterwise.
+            outfile (str): optional output PDF file path. If ommited, the
+                `.pdf.output(...)` method can be manuallyy called afterwise.
             dest (str): [**DEPRECATED**] unused, will be removed in a later version
         """
         if dest:
@@ -294,7 +294,8 @@ def barcode(
         if font == "interleaved 2of5 nt":
             pdf.interleaved2of5(text, x1, y1, w=size, h=y2 - y1)
 
-    # Added by Derek Schwalenberg Schwalenberg1013@gmail.com to allow (url) links in templates (using write method) 2014-02-22
+    # Added by Derek Schwalenberg Schwalenberg1013@gmail.com to allow (url) links in
+    # templates (using write method) 2014-02-22
     @staticmethod
     def write(
         pdf,

fpdf/ttfonts.py

@@ -69,7 +69,9 @@ def calcChecksum(data):
 
 class TTFontFile:
     def __init__(self):
-        self.maxStrLenRead = 200000  # Maximum size of glyf table to read in as string (otherwise reads each glyph from file)
+        # Maximum size of glyph table to read in as string
+        # (otherwise reads each glyph from file)
+        self.maxStrLenRead = 200000
 
     def getMetrics(self, file):
         self.filename = file
@@ -277,7 +279,8 @@ def extractInfo(self):
             raise RuntimeError(f"Unknown glyph data format {glyphDataFormat}")
 
         # hhea metrics table
-        # ttf2t1 seems to use this value rather than the one in OS/2 - so put in for compatibility
+        # ttf2t1 seems to use this value rather than the one in OS/2 - so put in for
+        # compatibility
         if "hhea" in self.tables:
             self.seek_table("hhea")
             self.skip(4)
@@ -396,9 +399,9 @@ def extractInfo(self):
 
         if not unicode_cmap_offset and not unicode_cmap_offset12:
             raise RuntimeError(
-                "Font ("
-                + self.filename
-                + ") does not have cmap for Unicode (platform 3, encoding 1, format 4, or platform 3, encoding 10, format 12, or platform 0, any encoding, format 4)"
+                f"Font ({self.filename}) does not have cmap for Unicode (platform 3, "
+                f"encoding 1, format 4, or platform 3, encoding 10, format 12, or "
+                f"platform 0, any encoding, format 4)"
             )
 
         glyphToChar = {}
@@ -473,9 +476,9 @@ def makeSubset(self, file, subset):
 
             if not unicode_cmap_offset and not unicode_cmap_offset12:
                 raise RuntimeError(
-                    "Font ("
-                    + self.filename
-                    + ") does not have cmap for Unicode (platform 3, encoding 1, format 4, or platform 3, encoding 10, format 12, or platform 0, any encoding, format 4)"
+                    f"Font ({self.filename}) does not have cmap for Unicode "
+                    f"(platform 3, encoding 1, format 4, or platform 3, encoding 10, "
+                    f"format 12, or platform 0, any encoding, format 4)"
                 )
 
             glyphToChar = {}
@@ -511,7 +514,9 @@ def makeSubset(self, file, subset):
             subsetglyphs.sort()
             glyphSet = {}
             n = 0
-            fsLastCharIndex = 0  # maximum Unicode index (character code) in this font, according to the cmap subtable for platform ID 3 and platform- specific encoding ID 0 or 1.
+            # maximum Unicode index (character code) in this font, according to the cmap
+            # subtable for platform ID 3 and platform- specific encoding ID 0 or 1.
+            fsLastCharIndex = 0
             for originalGlyphIdx, uni in subsetglyphs:
                 fsLastCharIndex = max(fsLastCharIndex, uni)
                 glyphSet[originalGlyphIdx] = n  # old glyphID to new glyphID
@@ -624,7 +629,7 @@ def makeSubset(self, file, subset):
             for subrange in range_:
                 cmap.append(
                     0
-                )  # idRangeOffset[segCount]      Offset in bytes to glyph indexArray, or 0
+                )  # idRangeOffset[segCount]   Offset in bytes to glyph indexArray, or 0
 
             cmap.append(0)  # idRangeOffset of last Segment
             for subrange, glidx in range_:
@@ -639,7 +644,8 @@ def makeSubset(self, file, subset):
                     try:
                         cmapstr += pack(">h", cm)
                     except StructError:
-                        # cmap value too big to fit in a short (h), putting it in an unsigned short (H):
+                        # cmap value too big to fit in a short (h),
+                        # putting it in an unsigned short (H):
                         cmapstr += pack(">H", -cm)
             self.add("cmap", cmapstr)
 
@@ -835,7 +841,8 @@ def resize_cw(size, default):
             if glyph in glyphToChar or glyph == 0:
                 if aw >= (1 << 15):
                     aw = 0  # 1.03 Some (arabic) fonts have -ve values for width
-                    # although should be unsigned value - comes out as e.g. 65108 (intended -50)
+                    # although should be unsigned value
+                    # - comes out as e.g. 65108 (intended -50)
                 if glyph == 0:
                     self.defaultWidth = scale * aw
                     continue

fpdf/util/syntax.py

@@ -1,8 +1,8 @@
 """PDF Syntax Helpers
 
 Functions in this module take variable input and produce PDF Syntax features
-as they are described in the Adobe PDF Reference Manual, found
-[here](http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf).
+as they are described in the Adobe PDF Reference Manual, found here:
+http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf
 
 Most of what happens in a PDF happens in objects, which are formatted like so:
 <pre>

test/class_unit_test/__init__.py test/barcodes/__init__.pytest/class_unit_test/__init__.py renamed to test/barcodes/__init__.py

@@ -6,19 +6,19 @@
 HERE = Path(__file__).resolve().parent
 
 
-class TestBarcodes:
-    def test_code39(self, tmp_path):
-        pdf = FPDF()
-        pdf.add_page()
-        pdf.code39("fpdf2", x=50, y=50, w=4, h=20)
-        pdf.set_font("courier", "B", size=36)
-        pdf.text(x=80, y=80, txt="fpdf2")
-        assert_pdf_equal(pdf, HERE / "barcodes_code39.pdf", tmp_path)
+def test_code39(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.code39("fpdf2", x=50, y=50, w=4, h=20)
+    pdf.set_font("courier", "B", size=36)
+    pdf.text(x=80, y=80, txt="fpdf2")
+    assert_pdf_equal(pdf, HERE / "barcodes_code39.pdf", tmp_path)
 
-    def test_interleaved2of5(self, tmp_path):
-        pdf = FPDF()
-        pdf.add_page()
-        pdf.interleaved2of5("1337", x=65, y=50, w=4, h=20)
-        pdf.set_font("courier", "B", size=36)
-        pdf.text(x=80, y=80, txt="1337")
-        assert_pdf_equal(pdf, HERE / "barcodes_interleaved2of5.pdf", tmp_path)
+
+def test_interleaved2of5(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.interleaved2of5("1337", x=65, y=50, w=4, h=20)
+    pdf.set_font("courier", "B", size=36)
+    pdf.text(x=80, y=80, txt="1337")
+    assert_pdf_equal(pdf, HERE / "barcodes_interleaved2of5.pdf", tmp_path)