Merge pull request #214 from bskinn/vendor-fuzz

Vendor fuzzywuzzy and update project infra

Author: bskinn

.coveragerc

@@ -1,11 +1,10 @@
 [run]
 omit =
-    # Don't do coverage on test code
-    sphobjinv/test/*
-    tests.py
-
-    # Don't cover code in the env (Termux only?)
+    # Don't cover code in the env (just in case)
     env/*
+    
+    # Don't worry about covering vendored libraries
+    src/sphobjinv/_vendored/*
 
 [report]
 exclude_lines =

.github/workflows/ci_tests.yml

@@ -4,7 +4,7 @@ on: push
 
 jobs:
   all_checks:
-    name: Run all tests, lints, etc. (Python 3.9)
+    name: Run all tests, lints, etc. (Python 3.10)
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
@@ -15,7 +15,7 @@ jobs:
     - name: Install Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.9
+        python-version: '3.10'
 
     - name: Update pip & setuptools
       run: python -m pip install -U pip setuptools
@@ -59,7 +59,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ['3.6', '3.7', '3.8']
+        python: ['3.6', '3.7', '3.8', '3.9']
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
     steps:
@@ -90,4 +90,4 @@ jobs:
       run: |
         pytest --cov=src --testall --nonloc
         tox -e sdist_install
-      
+      

CHANGELOG.md

@@ -7,12 +7,31 @@ and this project strives to adhere to
 [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
-### [unreleased]
+### [2.2b1] - *pending*
+
+#### Removed
+
+  * Acceleration of the `suggest` functionality via use of `python-Levenshtein`
+    is no longer possible due to the vendoring of an early, MIT-licensed version
+    of `fuzzywuzzy`, as noted below. The `speedup` install extra is now obsolete,
+    and has been removed.
+
+#### Internal
+
+  * The `fuzzywuzzy` string matcher was vendored into the project from a point
+    in its development history before the `python-Levenshtein` dependency,
+    and its corresponding GPL encumbrance, was introduced.
 
 #### Administrative
 
   * Project default branch migrated to `main` from `master`.
 
+  * Standard development Python version bumped to 3.10.
+
+  * Standard development Sphinx version bumped to 4.3.1.
+
+  * Active support for Python 3.11 added.
+
 
 ### [2.1] - 2021-04-14
 

CONTRIBUTING.md

@@ -43,7 +43,7 @@ in whatever location you prefer. Any Python interpreter 3.6+ *should* work fine.
 I prefer to use `virtualenv` and create in `./env`:
 
 ```
-$ python3.9 -m virtualenv env --prompt="(sphobjinv) "
+$ python3.10 -m virtualenv env --prompt="(sphobjinv) "
 ```
 
 Activate the environment:
@@ -138,7 +138,7 @@ configured for the project, it is **not** set up to be an everyday test runner.
 Instead, it's used to execute a matrix of test environments
 checking for the compatibility of different Python and  dependency
 versions. You can run it if you want, but you'll need
-working versions of all of Python 3.6 through 3.10
+working versions of all of Python 3.6 through 3.11
 installed and on `PATH` as `python3.6`, `python3.7`, etc.
 The nonlocal test suite is run for each `tox` environment, so
 it's best to use at most two parallel sub-processes to avoid oversaturating
@@ -239,7 +239,7 @@ and the link validity checker with `make linkcheck`.
 Both Github Actions and Azure Pipelines are set up for the project,
 and should run on any forks of the repository.
 
-Github Actions runs the test suite on Linux for Python 3.6 through 3.9,
+Github Actions runs the test suite on Linux for Python 3.6 through 3.10,
 as well as the `flake8` lints and the Sphinx doctests and link-validity testing,
 and is configured to run on all commits. The workflow can be skipped
 per-commit by including `[skip ci]` in the commit message.

README.rst

@@ -47,15 +47,21 @@ to cross-reference into, and pass it to ``sphobjinv suggest``.
 
 For internal cross-references, locate ``objects.inv`` within ``build/html``::
 
-    $ sphobjinv suggest doc/build/html/objects.inv as_rst -st 50
-
-      Name                                                     Score
-    --------------------------------------------------------  -------
-    :py:method:`sphobjinv.data.SuperDataObj.as_rst`             60
-    :std:doc:`cli/implementation/parser`                        57
-    :py:module:`sphobjinv.cli.parser`                           50
-    :py:method:`sphobjinv.data.SuperDataObj.as_str`             50
-    :py:method:`sphobjinv.inventory.Inventory.objects_rst`      50
+    $ sphobjinv suggest doc/build/html/objects.inv as_rst -st 58
+
+      Name                                                Score
+    ---------------------------------------------------  -------
+    :py:property:`sphobjinv.data.SuperDataObj.as_rst`      60
+    :py:class:`sphobjinv.cli.parser.PrsConst`              59
+    :py:class:`sphobjinv.data.DataFields`                  59
+    :py:class:`sphobjinv.data.DataObjBytes`                59
+    :py:class:`sphobjinv.data.DataObjStr`                  59
+    :py:class:`sphobjinv.data.SuperDataObj`                59
+    :py:class:`sphobjinv.enum.HeaderFields`                59
+    :py:class:`sphobjinv.enum.SourceTypes`                 59
+    :py:function:`sphobjinv.fileops.writebytes`            59
+    :py:function:`sphobjinv.fileops.writejson`             59
+    :py:class:`sphobjinv.inventory.Inventory`              59
 
 .. end shell command
 
@@ -120,11 +126,11 @@ inventory creation/modification::
     >>> import sphobjinv as soi
     >>> inv = soi.Inventory('doc/build/html/objects.inv')
     >>> print(inv)
-    <Inventory (fname_zlib): sphobjinv v2.1, 205 objects>
+    <Inventory (fname_zlib): sphobjinv v2.2b1, 205 objects>
     >>> inv.project
     'sphobjinv'
     >>> inv.version
-    '2.1'
+    '2.2b1'
     >>> inv.objects[0]
     DataObjStr(name='sphobjinv.cli.core', domain='py', role='module', priority='0', uri='cli/implementation/core.html#module-$', dispname='-')
 

azure-pipelines.yml

@@ -21,7 +21,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install -U tox
       displayName: Install tox
@@ -43,7 +43,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install interrogate
       displayName: Install interrogate
@@ -67,39 +67,24 @@ stages:
           spec: '3.8'
         py39:
           spec: '3.9'
+        py310:
+          spec: '3.10'
         pypy3:
           spec: 'pypy3'
-      platforms: [linux, windows, macOs]
+      platforms: [linux, windows]
 
-  - job: Levenshtein
-    strategy:
-      matrix:
-        linux:
-          platform: Ubuntu-latest
-        macOs:
-          platform: macOS-latest
-
-    pool:
-      vmImage: $[ variables.platform ]
-
-    steps:
-    - task: UsePythonVersion@0
-      inputs:
-        versionSpec: '3.9'
-        architecture: 'x64'
-      displayName: Use Python 3.9
-
-    - script: pip install -U --force-reinstall -r requirements-ci.txt -e .[speedup]
-      displayName: Install CI requirements, plus python-Levenshtein
-
-    - script: pip list
-      displayName: Show full environment contents
-
-    - script: cd doc; make html; mkdir scratch
-      displayName: Build  the documentation for tests to work against (Linux/macOs)
-
-    - script: pytest --nonloc -k "not readme"
-      displayName: Run pytest without README tests
+  - template: azure-coretest.yml
+    parameters:
+      pythons:
+        py37:
+          spec: '3.7'
+        py38:
+          spec: '3.8'
+        py39:
+          spec: '3.9'
+        py310:
+          spec: '3.10'
+      platforms: [macOs]
 
 
 - stage: aux_tests
@@ -115,7 +100,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install . -r requirements-rtd.txt
       displayName: Install project, plus docs requirements
@@ -133,7 +118,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install -r requirements-dev.txt
       displayName: Install full dev requirements
@@ -150,7 +135,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install . -r requirements-rtd.txt
       displayName: Install doc requirements and local project
@@ -168,7 +153,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install -r requirements-dev.txt
       displayName: Install full dev requirements
@@ -191,7 +176,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install -r requirements-ci.txt
       displayName: Install CI requirements
@@ -211,7 +196,7 @@ stages:
     steps:
     - task: UsePythonVersion@0
       inputs:
-        versionSpec: '3.9'
+        versionSpec: '3.10'
 
     - script: pip install tox flake8-noqa -r requirements-flake8.txt
       displayName: Install requirements

pyproject.toml

@@ -18,5 +18,11 @@ exclude = '''
   | ^/[.]
   | ^/doc
   | ^/env
+  | ^/src/sphobjinv/_vendored
 )
 '''
+
+[tool.interrogate]
+exclude = ["src/sphobjinv/_vendored"]
+fail-under = 100
+verbose = 1

requirements-ci.txt

@@ -3,15 +3,14 @@ certifi
 codecov
 coverage
 dictdiffer
-fuzzywuzzy>=0.3
 jsonschema
 md-toc
 pytest>=4.4.0
 pytest-check>=0.4
 pytest-cov
 pytest-ordering
 pytest-timeout
-sphinx==3.5.0
+sphinx==4.3.1
 sphinx-issues
 sphinx-rtd-theme
 sphinxcontrib-programoutput

requirements-dev.txt

@@ -2,7 +2,7 @@ attrs>=17.4
 certifi
 coverage
 dictdiffer
-fuzzywuzzy>=0.3
+interrogate
 jsonschema
 md-toc
 pep517
@@ -13,7 +13,7 @@ pytest-ordering
 pytest-timeout
 restview
 rope
-sphinx==3.5.0
+sphinx==4.3.1
 sphinx-autobuild
 sphinx-issues
 sphinxcontrib-programoutput

requirements-rtd.txt

@@ -1,5 +1,5 @@
 attrs>=17.4
-sphinx==3.5.0
+sphinx==4.3.1
 sphinx-issues
 sphinx-rtd-theme
 sphinxcontrib-programoutput