Code formatting: ruff format . && ruff --select=I --fix . (#55)

# Description

`ruff format . && ruff --select=I --fix .`

Replaces both `black` and `isort` with `ruff` running rapidly in
`pre-commit`.

This separates automatic formatting changes (this PR) from more manual
and syntactical changes (in #54) to make the latter easier to review and
revert if necessary.

# Checklist:

- [x] I have performed a self-review of my code
- [ ] I have added comments to code where it is hard to understand
- [ ] I have made corresponding changes to the documentation

.github/ISSUE_TEMPLATE/sweep-template.yml

@@ -12,4 +12,4 @@ body:
         Unit Tests: Write unit tests for <FILE>. Test each function in the file. Make sure to test edge cases.
         Bugs: The bug might be in <FILE>. Here are the logs: ...
         Features: the new endpoint should use the ... class from <FILE> because it contains ... logic.
-        Refactors: We are migrating this function to ... version because ...
+        Refactors: We are migrating this function to ... version because ...

.github/workflows/deploy-github-pages.yml

@@ -38,4 +38,4 @@ jobs:
           # The GH actions bot is used by default if you didn't specify the two fields.
           # You can swap them out with your own user credentials.
           user_name: github-actions[bot]
-          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/first-interaction.yml

@@ -21,7 +21,7 @@ jobs:
             If this is a bug report, please include relevant logs to help us debug the problem.
           pr-message: |
             Hello! Thank you for your contribution.
-            
+
             If you are fixing a bug, please reference the issue number in the description.
 
             If you are implementing a feature request, please check with the maintainers that the feature will be accepted first.

.github/workflows/python-publish.yml

@@ -13,7 +13,7 @@ on:
     types: [published]
 
   workflow_dispatch: # This line allows manual triggering
-  
+
   #push:
   #  branches:
   #    - master

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: 'v4.5.0'
+    rev: v4.5.0
     hooks:
       - id: check-added-large-files
       - id: check-ast
@@ -12,18 +12,20 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-  - repo: https://github.com/psf/black
-    rev: '24.1.1'
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.2.1
     hooks:
-      - id: black
-        language_version: python3.11
-        exclude: ^notebooks
+      - id: ruff
+        args: [ --select=I ]  # isort
+      - id: ruff-format
 
   - repo: https://github.com/asottile/pyupgrade
     rev: 'v3.15.0'
     hooks:
       - id: pyupgrade
         args: [ --py38-plus ]
+
   -   repo: https://github.com/ikamensh/flynt/
       rev: '1.0.1'
       hooks:

.readthedocs.yaml

@@ -26,4 +26,4 @@ sphinx:
 python:
     install:
 #    - requirements: requirements.txt
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt

benchmark/enron.py

@@ -1,5 +1,5 @@
-from __future__ import division
-import os.path, tarfile
+import os.path
+import tarfile
 from email import message_from_string
 from marshal import dump, load
 from zlib import compress, decompress
@@ -10,11 +10,10 @@
     pass
 
 from whoosh import analysis, fields
-from whoosh.compat import urlretrieve, next
+from whoosh.compat import next, urlretrieve
 from whoosh.support.bench import Bench, Spec
 from whoosh.util import now
 
-
 # Benchmark class
 
 

benchmark/marc21.py

@@ -1,11 +1,12 @@
-from __future__ import with_statement, print_function
-import fnmatch, logging, os.path, re
+import fnmatch
+import logging
+import os.path
+import re
 
 from whoosh import analysis, fields, index, qparser, query, scoring
 from whoosh.compat import range
 from whoosh.util import now
 
-
 log = logging.getLogger(__name__)
 
 

benchmark/reuters.py

@@ -1,4 +1,5 @@
-import gzip, os.path
+import gzip
+import os.path
 
 from whoosh import analysis, fields, index, qparser, query
 from whoosh.support.bench import Bench, Spec

docs/Makefile

@@ -174,4 +174,4 @@ xml:
 pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/make.bat

@@ -239,4 +239,4 @@ if "%1" == "pseudoxml" (
 	goto end
 )
 
-:end
+:end

docs/requirements.txt

@@ -1,3 +1,3 @@
 sphinx
 sphinx_rtd_theme
-sphinx-jsonschema
+sphinx-jsonschema

docs/source/analysis.rst

@@ -324,6 +324,3 @@ change it. ;) Nothing requires that an Analyzer be implemented by calling a
 tokenizer and filters. Tokenizers and filters are simply a convenient way to
 structure the code. You're free to write an analyzer any way you want, as long
 as it implements ``__call__``.
-
-
-

docs/source/api/analysis.rst

@@ -59,4 +59,3 @@ Token classes and functions
 
 .. autoclass:: Token
 .. autofunction:: unstopped
-

docs/source/api/codec/base.rst

@@ -28,5 +28,3 @@ Classes
 
 .. autoclass:: Segment
    :members:
-
-

docs/source/api/collectors.rst

@@ -40,8 +40,3 @@ Wrappers
 .. autoclass:: TimeLimitCollector
 
 .. autoclass:: TermsCollector
-
-
-
-
-

docs/source/api/columns.rst

@@ -46,4 +46,3 @@ Experimental columns
 ====================
 
 .. autoclass:: ClampedNumericColumn
-

docs/source/api/formats.rst

@@ -20,5 +20,3 @@ Formats
 .. autoclass:: Characters
 .. autoclass:: PositionBoosts
 .. autoclass:: CharacterBoosts
-
-

docs/source/api/lang/wordnet.rst

@@ -17,4 +17,3 @@ Low-level functions
 .. autofunction:: parse_file
 .. autofunction:: synonyms
 .. autofunction:: make_index
-

docs/source/api/qparser.rst

@@ -88,10 +88,3 @@ Operators
 .. autoclass:: PrefixOperator
 .. autoclass:: PostfixOperator
 .. autoclass:: InfixOperator
-
-
-
-
-
-
-

docs/source/api/reading.rst

@@ -19,4 +19,3 @@ Exceptions
 ==========
 
 .. autoexception:: TermNotFound
-

docs/source/api/scoring.rst

@@ -36,7 +36,3 @@ Scoring utility classes
 .. autoclass:: MultiWeighting
 
 .. autoclass:: ReverseWeighting
-
-
-
-

docs/source/api/searching.rst

@@ -30,4 +30,3 @@ Exceptions
 
 .. autoexception:: NoTermsException
 .. autoexception:: TimeLimit
-

docs/source/api/sorting.rst

@@ -44,5 +44,3 @@ FacetType objects
 .. autoclass:: UnorderedList
 .. autoclass:: Count
 .. autoclass:: Best
-
-

docs/source/api/spelling.rst

@@ -27,5 +27,3 @@ QueryCorrector objects
 .. autoclass:: SimpleQueryCorrector
 
 .. autoclass:: Correction
-
-

docs/source/api/support/charset.rst

@@ -10,4 +10,3 @@
     Taken from http://speeple.com/unicode-maps.txt
 
 .. autofunction:: charset_table_to_dict
-

docs/source/api/support/levenshtein.rst

@@ -7,4 +7,3 @@
 .. autofunction:: relative
 
 .. autofunction:: distance
-

docs/source/api/util.rst

@@ -4,4 +4,3 @@
 
 .. automodule:: whoosh.util
     :members:
-

docs/source/api/writing.rst

@@ -26,5 +26,3 @@ Exceptions
 ==========
 
 .. autoexception:: IndexingError
-
-

docs/source/batch.rst

@@ -106,9 +106,3 @@ So, while ``multisegment=True`` is much faster than a normal writer, you should
 only use it for large batch indexing jobs (or perhaps only for indexing from
 scratch). It should not be the only method you use for indexing, because
 otherwise the number of segments will tend to increase forever!
-
-
-
-
-
-

docs/source/conf.py

@@ -1,4 +1,6 @@
-import sys, os, os.path
+import os
+import os.path
+import sys
 
 sys.path.append(os.path.abspath("../../src"))
 import whoosh

docs/source/dates.rst

@@ -196,7 +196,3 @@ Limitations
 
 * ``DATETIME`` fields do not currently support open-ended ranges. You can
   simulate an open ended range by using an endpoint far in the past or future.
-
-
-
-

docs/source/facets.rst

@@ -767,5 +767,3 @@ Expert: writing your own facet
 ==============================
 
 TBD.
-
-

docs/source/fieldcaches.rst

@@ -44,9 +44,3 @@ Then you can pass an instance of your policy object to the ``set_caching_policy`
 method::
 
     searcher.set_caching_policy(MyPolicy())
-
-
-
-
-
-

docs/source/glossary.rst

@@ -62,4 +62,3 @@ Glossary
     Term vector
         A *forward index* for a certain field in a certain document. You can specify
         in the Schema that a given field should store term vectors.
-

docs/source/highlight.rst

@@ -405,15 +405,3 @@ an analyzer::
 ``order``
     An ordering function that determines the order of the "top" fragments in the
     output text.
-
-
-
-
-
-
-
-
-
-
-
-

docs/source/index.rst

@@ -47,4 +47,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-

docs/source/keywords.rst

@@ -91,4 +91,3 @@ Expansion models
 The ``ExpansionModel`` subclasses in the :mod:` whoosh.classify` module implement
 different weighting functions for key words. These models are translated into
 Python from original Java implementations in Terrier.
-

docs/source/nested.rst

@@ -235,4 +235,3 @@ additional searches for each found document.
 
 Future versions of Whoosh may include "join" queries to make this process more
 efficient (or at least more automatic).
-

docs/source/ngrams.rst

@@ -46,6 +46,3 @@ whitespace and punctuation, while ``NGRAMWORDS`` extracts words from the text
 using a tokenizer, then runs each word through the N-gram filter.
 
 TBD.
-
-
-

docs/source/parsing.rst

@@ -185,7 +185,7 @@ replace the default English tokens with your own regular expressions.
 
 The :class:` whoosh.qparser.OperatorsPlugin` implements the ability to use AND,
 OR, NOT, ANDNOT, and ANDMAYBE clauses in queries. You can instantiate a new
-``OperatorsPlugin`` and use the ``And``, ``Or``, ``Not``, ``AndNot``, and 
+``OperatorsPlugin`` and use the ``And``, ``Or``, ``Not``, ``AndNot``, and
 ``AndMaybe`` keyword arguments to change the token patterns::
 
     # Use Spanish equivalents instead of AND and OR
@@ -430,8 +430,3 @@ use the ``clean`` keyword argument::
 
 Operators earlier in the list bind more closely than operators later in the
 list.
-
-
-
-
-

docs/source/query.rst

@@ -7,4 +7,3 @@ The classes in the :mod:` whoosh.query` module implement *queries* you can run a
 TBD.
 
 See :doc:`searching` for how to search the index using query objects.
-

docs/source/querylang.rst

@@ -186,6 +186,3 @@ in single quotes::
     path:'MacHD:My Documents'
     'term with spaces'
     title:'function()'
-
-
-

docs/source/quickstart.rst

@@ -241,4 +241,3 @@ Whoosh includes extra features for dealing with search results, such as
 * Paginating the results (e.g. "Showing results 1-20, page 1 of 4").
 
 See :doc:`searching` for more information.
-

docs/source/recipes.rst

@@ -226,4 +226,3 @@ Is term X in document Y?
     # ...or the slower but easier way
     wordset = set(searcher.vector(500, "content").all_ids())
     return "wobble" in wordset
-

docs/source/releases/1_0.rst

@@ -479,4 +479,3 @@ Misc
   previous versions.
 
 * Unit tests should no longer leave directories and files behind.
-

docs/source/releases/2_0.rst

@@ -328,6 +328,3 @@ Compatibility
   now yield :class:` whoosh.reading.TermInfo` objects.
 
 * The arguments to :class:` whoosh.query.FuzzyTerm` changed.
-
-
-

docs/source/releases/index.rst

@@ -8,4 +8,3 @@ Release notes
     2_0
     1_0
     0_3
-

docs/source/schema.rst

@@ -371,7 +371,3 @@ If you set ``FieldType.vector`` to a ``Format`` object, the indexing code will u
 ``Format`` object to store information about the terms in each document. Currently
 by default Whoosh does not make use of term vectors at all, but they are
 available to expert users who want to implement their own field types.
-
-
-
-