Migrate linting to Ruff and update CI settings (#359)

Replace flake8, black, and isort with Ruff as the unified linter and formatter.

- Applied auto-fixes from Ruff
- Removed legacy configuration for flake8, black, and isort
- Updated CI settings to prevent job cancelation on master

Author: mxamin

.github/workflows/linuxbrew.yml

@@ -2,7 +2,7 @@ name: linuxbrew
 on: [push, pull_request]
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.ref_name != 'master' }}
 jobs:
   linuxbrew:
     runs-on: ubuntu-latest

.github/workflows/macosx.yml

@@ -2,7 +2,7 @@ name: macOS
 on: [push, pull_request]
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.ref_name != 'master' }}
 jobs:
   macosx:
     runs-on: macos-latest

.github/workflows/manylinux.yml

@@ -2,7 +2,7 @@ name: manylinux
 on: [push, pull_request]
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.ref_name != 'master' }}
 jobs:
   manylinux:
     runs-on: ubuntu-latest

.github/workflows/sdist.yml

@@ -2,7 +2,7 @@ name: sdist
 on: [push, pull_request]
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.ref_name != 'master' }}
 jobs:
   sdist:
     # Avoid Ubuntu 24.04 in sdist workflows, because it contains libxmlsec1-dev

.github/workflows/wheels.yml

@@ -17,7 +17,7 @@ on:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
+  cancel-in-progress: ${{ github.ref_name != 'master' }}
 
 permissions: {}
 

.pre-commit-config.yaml

@@ -1,48 +1,42 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-    -   id: black
-        types: []
-        files: ^.*.pyi?$
-        exclude: ^doc/
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
-    hooks:
-    -   id: no-commit-to-branch
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-yaml
-    -   id: check-added-large-files
-    -   id: check-ast
-    -   id: check-merge-conflict
-    -   id: check-json
-    -   id: detect-private-key
-        exclude: ^.*/rsakey.pem$
-    -   id: mixed-line-ending
-    -   id: pretty-format-json
-        args: [--autofix]
--   repo: https://github.com/PyCQA/flake8
-    rev: 7.3.0
-    hooks:
-    -   id: flake8
-        exclude: ^setup.py$
-        additional_dependencies: [flake8-docstrings, flake8-bugbear, flake8-logging-format, flake8-builtins, flake8-eradicate, flake8-fixme, pep8-naming, flake8-pep3101, flake8-annotations-complexity,flake8-pyi]
--   repo: https://github.com/PyCQA/isort
-    rev: 6.0.1
-    hooks:
-    -   id: isort
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.16.1
-    hooks:
-    -   id: mypy
-        exclude: (setup.py|tests/.*.py|doc/.*)
-        types: []
-        files: ^.*.pyi?$
-        additional_dependencies: [lxml-stubs,types-docutils]
--   repo: https://github.com/pre-commit/pygrep-hooks
-    rev: v1.10.0
-    hooks:
-    -   id: rst-backticks
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.12.3
+  hooks:
+    - id: ruff
+      args: ["--fix"]
+      types: [python]
+    - id: ruff-format
+      types: [python]
+
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: no-commit-to-branch
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: check-ast
+    - id: check-merge-conflict
+    - id: check-json
+    - id: detect-private-key
+      exclude: ^.*/rsakey.pem$
+    - id: mixed-line-ending
+    - id: pretty-format-json
+      args: [--autofix]
+
+- repo: https://github.com/pre-commit/mirrors-mypy
+  rev: v1.16.1
+  hooks:
+    - id: mypy
+      exclude: (setup.py|tests/.*.py|doc/.*)
+      types: []
+      files: ^.*.pyi?$
+      additional_dependencies: [lxml-stubs, types-docutils]
+
+- repo: https://github.com/pre-commit/pygrep-hooks
+  rev: v1.10.0
+  hooks:
+    - id: rst-backticks

doc/source/conf.py

@@ -19,12 +19,12 @@
 source_suffix = '.rst'
 master_doc = 'index'
 
-project = u'python-xmlsec'
-copyright = u'2020, Oleg Hoefling <[email protected]>'  # noqa: A001
-author = u'Bulat Gaifullin <[email protected]>'
+project = 'python-xmlsec'
+copyright = '2020, Oleg Hoefling <[email protected]>'
+author = 'Bulat Gaifullin <[email protected]>'
 release = importlib.metadata.version('xmlsec')
 parsed: Version = parse(release)
-version = '{}.{}'.format(parsed.major, parsed.minor)
+version = f'{parsed.major}.{parsed.minor}'
 
 exclude_patterns: list[str] = []
 pygments_style = 'sphinx'
@@ -39,19 +39,19 @@
     (
         master_doc,
         'python-xmlsec.tex',
-        u'python-xmlsec Documentation',
-        u'Bulat Gaifullin \\textless{}[email protected]\\textgreater{}',
+        'python-xmlsec Documentation',
+        'Bulat Gaifullin \\textless{}[email protected]\\textgreater{}',
         'manual',
     )
 ]
 
-man_pages = [(master_doc, 'python-xmlsec', u'python-xmlsec Documentation', [author], 1)]
+man_pages = [(master_doc, 'python-xmlsec', 'python-xmlsec Documentation', [author], 1)]
 
 texinfo_documents = [
     (
         master_doc,
         'python-xmlsec',
-        u'python-xmlsec Documentation',
+        'python-xmlsec Documentation',
         author,
         'python-xmlsec',
         'One line description of project.',
@@ -63,10 +63,10 @@
 autodoc_docstring_signature = True
 
 
-rst_prolog = '''
+rst_prolog = """
 .. role:: xml(code)
    :language: xml
-'''
+"""
 
 # LXML crossref'ing stuff:
 # LXML doesn't have an intersphinx docs,
@@ -75,8 +75,7 @@
 
 
 def lxml_element_doc_reference(app: Sphinx, env: BuildEnvironment, node: pending_xref, contnode: Text) -> reference:
-    """
-    Handle a missing reference only if it is a ``lxml.etree._Element`` ref.
+    """Handle a missing reference only if it is a ``lxml.etree._Element`` ref.
 
     We handle only :class:`lxml.etree._Element` and :class:`~lxml.etree._Element` nodes.
     """
@@ -85,7 +84,7 @@ def lxml_element_doc_reference(app: Sphinx, env: BuildEnvironment, node: pending
         and node.get('reftarget', None) == 'lxml.etree._Element'
         and contnode.astext() in ('lxml.etree._Element', '_Element')
     ):
-        reftitle = '(in lxml v{})'.format(lxml.__version__)  # type: ignore[attr-defined]
+        reftitle = f'(in lxml v{lxml.__version__})'  # type: ignore[attr-defined]
         newnode = reference('', '', internal=False, refuri=lxml_element_cls_doc_uri, reftitle=reftitle)
         newnode.append(contnode)
         return newnode

doc/source/examples/decrypt.py

@@ -6,7 +6,7 @@
 key = xmlsec.Key.from_file('rsakey.pem', xmlsec.constants.KeyDataFormatPem)
 manager.add_key(key)
 enc_ctx = xmlsec.EncryptionContext(manager)
-root = etree.parse("enc1-res.xml").getroot()
-enc_data = xmlsec.tree.find_child(root, "EncryptedData", xmlsec.constants.EncNs)
+root = etree.parse('enc1-res.xml').getroot()
+enc_data = xmlsec.tree.find_child(root, 'EncryptedData', xmlsec.constants.EncNs)
 decrypted = enc_ctx.decrypt(enc_data)
 print(etree.tostring(decrypted))

doc/source/examples/encrypt.py

@@ -9,11 +9,11 @@
     template,
     xmlsec.constants.TransformAes128Cbc,
     type=xmlsec.constants.TypeEncElement,
-    ns="xenc",
+    ns='xenc',
 )
 
 xmlsec.template.encrypted_data_ensure_cipher_value(enc_data)
-key_info = xmlsec.template.encrypted_data_ensure_key_info(enc_data, ns="dsig")
+key_info = xmlsec.template.encrypted_data_ensure_key_info(enc_data, ns='dsig')
 enc_key = xmlsec.template.add_encrypted_key(key_info, xmlsec.constants.TransformRsaOaep)
 xmlsec.template.encrypted_data_ensure_cipher_value(enc_key)
 data = template.find('./Data')
@@ -24,20 +24,10 @@
 manager.add_key(key)
 
 enc_ctx = xmlsec.EncryptionContext(manager)
-enc_ctx.key = xmlsec.Key.generate(
-    xmlsec.constants.KeyDataAes, 128, xmlsec.constants.KeyDataTypeSession
-)
+enc_ctx.key = xmlsec.Key.generate(xmlsec.constants.KeyDataAes, 128, xmlsec.constants.KeyDataTypeSession)
 enc_data = enc_ctx.encrypt_xml(enc_data, data)
-enc_method = xmlsec.tree.find_child(
-    enc_data, xmlsec.constants.NodeEncryptionMethod, xmlsec.constants.EncNs
-)
-key_info = xmlsec.tree.find_child(
-    enc_data, xmlsec.constants.NodeKeyInfo, xmlsec.constants.DSigNs
-)
-enc_method = xmlsec.tree.find_node(
-    key_info, xmlsec.constants.NodeEncryptionMethod, xmlsec.constants.EncNs
-)
-cipher_value = xmlsec.tree.find_node(
-    key_info, xmlsec.constants.NodeCipherValue, xmlsec.constants.EncNs
-)
+enc_method = xmlsec.tree.find_child(enc_data, xmlsec.constants.NodeEncryptionMethod, xmlsec.constants.EncNs)
+key_info = xmlsec.tree.find_child(enc_data, xmlsec.constants.NodeKeyInfo, xmlsec.constants.DSigNs)
+enc_method = xmlsec.tree.find_node(key_info, xmlsec.constants.NodeEncryptionMethod, xmlsec.constants.EncNs)
+cipher_value = xmlsec.tree.find_node(key_info, xmlsec.constants.NodeCipherValue, xmlsec.constants.EncNs)
 print(etree.tostring(cipher_value))

doc/source/examples/verify.py

@@ -5,7 +5,7 @@
 with open('sign1-res.xml') as fp:
     template = etree.parse(fp).getroot()
 
-xmlsec.tree.add_ids(template, ["ID"])
+xmlsec.tree.add_ids(template, ['ID'])
 signature_node = xmlsec.tree.find_node(template, xmlsec.constants.NodeSignature)
 # Create a digital signature context (no key manager is needed).
 ctx = xmlsec.SignatureContext()