Update development tools: travis ci to github actions, tox to nox, no…

…se to pytest (#704)

* Replace tox with nox

* Replace travis with github actions

* Fix pytest, mypy and flake8 errors

* Add pytest.

* Run on all commits

* Remove nose

* Speedup slow tests to save GitHub actions minutes

* Added line to CHANGELOG.md

* Fix line too long in pdfdocument.py

* Update .github/workflows/actions.yml

Co-authored-by: Jake Stockwin <jstockwin@gmail.com>

* Improve actions.yml

* Fix error with nox name for mypy

* Add names for jobs

* Replace nose.raises with pytest.raises

Co-authored-by: Jake Stockwin <jstockwin@gmail.com>

.github/workflows/actions.yml

@@ -0,0 +1,94 @@
+name: Continuous integration
+
+on:
+  push:
+
+env:
+  default-python: "3.10"
+
+jobs:
+
+  check-coding-style:
+    name: Check coding style
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ env.default-python }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ env.default-python }}
+      - name: Upgrade pip, Install nox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install nox
+      - name: Check coding style
+        run: |
+          nox --error-on-missing-interpreters --non-interactive --session lint
+
+  check-static-types:
+    name: Check static types
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ env.default-python }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ env.default-python }}
+      - name: Upgrade pip, Install nox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install nox
+      - name: Check static types
+        run: |
+          nox --error-on-missing-interpreters --non-interactive --session types
+
+  tests:
+    name: Run tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ "3.6", "3.7", "3.8", "3.9", "3.10" ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Determine pip cache directory
+        id: pip-cache
+        run: |
+          echo "::set-output name=dir::$(pip cache dir)"
+      - name: Cache pip cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip${{ matrix.python-version }}
+      - name: Upgrade pip and install nox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install nox
+      - name: Run tests
+        run: |
+          nox --non-interactive --session tests-${{ matrix.python-version }}
+
+  build-docs:
+    name: Test building docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Python ${{ env.default-python }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ env.default-python }}
+      - name: Upgrade pip and install nox
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install nox
+      - name: Build docs
+        run: |
+          nox --error-on-missing-interpreters --non-interactive --session docs

.gitignore

@@ -17,6 +17,7 @@ tests/*.xml
 tests/*.txt
 .idea/
 .tox/
+.nox/
 
 # python venv management tools
 Pipfile

CHANGELOG.md

@@ -24,6 +24,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Removed
 - Unnecessary return statements without argument at the end of functions ([#707](https://github.com/pdfminer/pdfminer.six/pull/707))
 
+### Changed
+- Switched from nose to pytest, from tox to nox and from Travis CI to GitHub Actions ([#704](https://github.com/pdfminer/pdfminer.six/pull/704))
+
 ## [20211012]
 
 ### Added

CONTRIBUTING.md

@@ -60,11 +60,11 @@ Any contribution is appreciated! You might want to:
     On all Python versions:
 
     ```sh
-    tox
+    nox
    ```
 
    Or on a single Python version:
 
    ```sh
-    tox -e py36
+    nox -e py36
     ```

Makefile

@@ -53,6 +53,3 @@ $(CMAPDST)/to-unicode-Adobe-Japan1.pickle.gz: $(CMAPDST)
 $(CMAPDST)/to-unicode-Adobe-Korea1.pickle.gz: $(CMAPDST)
 	$(CONV_CMAP) -c KSC-EUC=euc-kr -c KSC-Johab=johab -c KSCms-UHC=cp949 -c UniKS-UTF8=utf-8 \
 		$(CMAPDST) Adobe-Korea1 $(CMAPSRC)/cid2code_Adobe_Korea1.txt
-
-test: cmap
-	nosetests

mypy.ini

@@ -20,8 +20,11 @@ disallow_untyped_defs = True
 [mypy-cryptography.hazmat.*]
 ignore_missing_imports = True
 
-[mypy-nose.*]
+[mypy-pytest.*]
 ignore_missing_imports = True
 
 [mypy-setuptools]
 ignore_missing_imports = True
+
+[mypy-nox]
+ignore_missing_imports = True

noxfile.py

@@ -0,0 +1,58 @@
+import nox
+
+
+PYTHON_ALL_VERSIONS = ["3.6", "3.7", "3.8", "3.9", "3.10"]
+
+
+@nox.session
+def lint(session):
+    session.install('flake8')
+    session.run(
+        'flake8',
+        'pdfminer/',
+        'tools/',
+        'tests/',
+        '--count',
+        '--statistics'
+    )
+
+
+@nox.session
+def types(session):
+    session.install('mypy')
+    session.run(
+        'mypy',
+        '--install-types',
+        '--non-interactive',
+        '--show-error-codes',
+        '.'
+    )
+
+
+@nox.session(python=PYTHON_ALL_VERSIONS)
+def tests(session):
+    session.install("-e", ".[dev]")
+    session.run('pytest')
+
+
+@nox.session
+def docs(session):
+    session.install("-e", ".[docs]")
+    session.run(
+        'python',
+        '-m',
+        'sphinx',
+        '-b',
+        'html',
+        'docs/source',
+        'docs/build/html'
+    )
+    session.run(
+        'python',
+        '-m',
+        'sphinx',
+        '-b',
+        'doctest',
+        'docs/source',
+        'docs/build/doctest'
+    )

pdfminer/data_structures.py

@@ -1,5 +1,4 @@
-import functools
-from typing import Any, Dict, Iterable, List, Optional, Tuple
+from typing import Any, Iterable, List, Optional, Tuple
 
 from pdfminer import settings
 from pdfminer.pdfparser import PDFSyntaxError
@@ -26,21 +25,20 @@ def __init__(self, obj: Any):
             self.limits = list_value(self._obj['Limits'])
 
     def _parse(self) -> List[Tuple[int, Any]]:
-        l = []
+        items = []
         if self.nums:  # Leaf node
             for k, v in choplist(2, self.nums):
-                l.append((int_value(k), v))
+                items.append((int_value(k), v))
 
         if self.kids:  # Root or intermediate node
             for child_ref in self.kids:
-                l += NumberTree(child_ref)._parse()
+                items += NumberTree(child_ref)._parse()
 
-        return l
+        return items
 
     values: List[Tuple[int, Any]]  # workaround decorators unsupported by mypy
 
-    @property  # type: ignore [no-redef,misc]
-    @functools.lru_cache
+    @property  # type: ignore[no-redef,misc]
     def values(self) -> List[Tuple[int, Any]]:
         values = self._parse()
 

pdfminer/image.py

@@ -2,7 +2,7 @@
 import os.path
 import struct
 from io import BytesIO
-from typing import BinaryIO, Tuple
+from typing import BinaryIO, Tuple, List, Any
 
 from .jbig2 import JBIG2StreamReader, JBIG2StreamWriter
 from .layout import LTImage
@@ -104,6 +104,7 @@ def export_image(self, image: LTImage) -> str:
             # seems to be easily opened by other programs
             from PIL import Image
             raw_data = image.stream.get_rawdata()
+            assert raw_data is not None
             ifp = BytesIO(raw_data)
             i = Image.open(ifp)
             i.save(fp, 'JPEG2000')
@@ -162,7 +163,7 @@ def is_jbig2_image(image: LTImage) -> bool:
         return is_jbig2
 
     @staticmethod
-    def jbig2_global(image):
+    def jbig2_global(image: LTImage) -> List[Any]:
         global_streams = []
         filters = image.stream.get_filters()
         for filter_name, params in filters:

pdfminer/pdfdocument.py

@@ -13,9 +13,9 @@
 from .arcfour import Arcfour
 from .data_structures import NumberTree
 from .pdfparser import PDFSyntaxError, PDFParser, PDFStreamParser
-from .pdftypes import DecipherCallable, PDFException, PDFTypeError, PDFStream, \
-    PDFObjectNotFound, decipher_all, int_value, str_value, list_value, \
-    uint_value, dict_value, stream_value
+from .pdftypes import DecipherCallable, PDFException, PDFTypeError, \
+    PDFStream, PDFObjectNotFound, decipher_all, int_value, str_value, \
+    list_value, uint_value, dict_value, stream_value
 from .psparser import PSEOF, literal_name, LIT, KWD
 from .utils import choplist, decode_text, nunpack, format_int_roman, \
     format_int_alpha
@@ -51,6 +51,10 @@ class PDFEncryptionError(PDFException):
     pass
 
 
+class PDFPasswordIncorrect(PDFEncryptionError):
+    pass
+
+
 class PDFEncryptionWarning(UserWarning):
     """Legacy warning for failed decryption.
 

pdfminer/pdftypes.py

@@ -217,7 +217,7 @@ def stream_value(x: object) -> "PDFStream":
     return x
 
 
-def decompress_corrupted(data):
+def decompress_corrupted(data: bytes) -> bytes:
     """Called on some data that can't be properly decoded because of CRC checksum
     error. Attempt to decode it skipping the CRC.
     """

setup.py

@@ -1,6 +1,10 @@
+import sys
+from pathlib import Path
+
 from setuptools import setup
 from os import path
 
+sys.path.append(str(Path(__file__).parent))
 import pdfminer as package
 
 
@@ -17,7 +21,7 @@
         'cryptography',
     ],
     extras_require={
-        "dev": ["nose", "tox", "mypy == 0.910"],
+        "dev": ["pytest", "nox", "mypy == 0.931"],
         "docs": ["sphinx", "sphinx-argparse"],
     },
     description='PDF parser and analyzer',