formatn and lint

Author: erral

AGENTS.md

@@ -6,6 +6,8 @@ This document contains the guidelines, commands, and code style rules for AI cod
 
 This project uses `make` as the primary task runner, backed by `uv` for Python environment management and `hatchling` as the build system.
 
+**IMPORTANT MANDATE**: After you modify *any* Python, XML, ZCML, or PT file, you MUST run `make check` (or `make format && make lint`) and fix any resulting errors before completing your task.
+
 ### Installation and Running
 - **Install the project**: 
   ```bash

Makefile

@@ -100,7 +100,7 @@ create-site: $(VENV_FOLDER) instance/etc/zope.ini ## Create a new site from scra
 lint: ## Check and fix code base according to Plone standards
 	@echo "$(GREEN)==> Lint codebase$(RESET)"
 	@uvx ruff@latest check --fix --config $(BACKEND_FOLDER)/pyproject.toml
-	@uvx pyroma@latest -d .
+	@uvx --with hatchling --with pip pyroma@latest -d .
 	@uvx check-python-versions@latest .
 	@uvx zpretty@latest --check src
 

docs/docs/conf.py

@@ -5,10 +5,10 @@
 # -- Path setup --------------------------------------------------------------
 
 from datetime import datetime
-
 from packaging.version import Version
 from plone_sphinx_theme import __version__
 
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -24,7 +24,7 @@
 trademark_name = "codesyntax"
 now = datetime.now()
 year = str(now.year)
-copyright = year
+copyright = year  # noqa: A001
 
 
 # The version info for the project you're documenting, acts as replacement for
@@ -101,8 +101,8 @@
     r"https://github.com/.*#.*",
     # Ignore other specific anchors
 ]
-linkcheck_allowed_redirects = {  # TODO: Confirm usage of linkcheck_allowed_redirects
-    # All HTTP redirections from the source URI to the canonical URI will be treated as "working".
+linkcheck_allowed_redirects = {
+    # All HTTP redirections from the source URI to the canonical URI will be treated as "working".  # noqa: E501
 }
 linkcheck_anchors = True
 linkcheck_timeout = 5
@@ -132,7 +132,7 @@
 html_theme = "plone_sphinx_theme"  # This can be configured
 html_logo = "_static/logo.svg"
 html_favicon = "_static/favicon.svg"
-# The default value includes icon-links, so override it with that one omitted, and add it to html_theme_options[footer_content_items].
+# The default value includes icon-links, so override it with that one omitted, and add it to html_theme_options[footer_content_items].  # noqa: E501
 html_sidebars = {
     "**": [
         "navbar-logo",
@@ -142,8 +142,8 @@
 }
 html_theme_options = {
     "article_header_start": ["toggle-primary-sidebar"],
-    # "extra_footer": """<p>Example `extra_footer` content. License info. Trademark info and usage.</p>
-    # <p>Pull request previews by <a href="https://readthedocs.org/">Read the Docs</a>.</p>""",
+    # "extra_footer": """<p>Example `extra_footer` content. License info. Trademark info and usage.</p>  # noqa: E501
+    # <p>Pull request previews by <a href="https://readthedocs.org/">Read the Docs</a>.</p>""",  # noqa: E501
     "footer_content_items": [
         "author",
         "copyright",
@@ -248,12 +248,12 @@
 myst_enable_extensions = [
     "attrs_block",  # Support parsing of block attributes.
     "attrs_inline",  # Support parsing of inline attributes.
-    "colon_fence",  # You can also use ::: delimiters to denote code fences, instead of ```.
-    "deflist",  # Support definition lists. https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
-    "html_image",  # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images
+    "colon_fence",  # You can also use ::: delimiters to denote code fences, instead of ```.  # noqa: E501
+    "deflist",  # Support definition lists. https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists  # noqa: E501
+    "html_image",  # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images  # noqa: E501
     "linkify",  # Identify "bare" web URLs and add hyperlinks.
-    "strikethrough",  # See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-strikethrough
-    "substitution",  # Use Jinja2 for substitutions. https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
+    "strikethrough",  # See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-strikethrough  # noqa: E501
+    "substitution",  # Use Jinja2 for substitutions. https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2  # noqa: E501
 ]
 
 myst_substitutions = {}

src/cs_dynamicpages/tests/how_tos/test_configure_registry.py

@@ -1,8 +1,8 @@
-import unittest
+from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
 
-from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
+import unittest
 
 
 class TestHowToConfigureRegistry(unittest.TestCase):
@@ -33,8 +33,8 @@ def test_configure_row_widths(self):
         self.assertEqual(updated_widths[-1]["row_width_class"], "col-md-4 offset-md-4")
 
         # Test vocabulary behavior
-        from zope.schema.interfaces import IVocabularyFactory
         from zope.component import getUtility
+        from zope.schema.interfaces import IVocabularyFactory
 
         vocab_factory = getUtility(IVocabularyFactory, name="cs_dynamicpages.RowWidth")
         vocab = vocab_factory(self.portal)
@@ -63,8 +63,8 @@ def test_configure_spacers(self):
         self.assertEqual(updated_spacers[-1]["spacer_class"], "pt-12")
 
         # Test vocabulary behavior
-        from zope.schema.interfaces import IVocabularyFactory
         from zope.component import getUtility
+        from zope.schema.interfaces import IVocabularyFactory
 
         vocab_factory = getUtility(
             IVocabularyFactory, name="cs_dynamicpages.RowPaddingTop"

src/cs_dynamicpages/tests/how_tos/test_custom_row_view.py

@@ -1,13 +1,9 @@
-import unittest
-from zope.component import getUtility
-from plone.registry.interfaces import IRegistry
+from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
+from zope.component import getUtility
 
-from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
-from cs_dynamicpages.controlpanels.dynamic_pages_control_panel.controlpanel import (
-    IDynamicPagesControlPanel,
-)
+import unittest
 
 
 class TestHowToCustomRowView(unittest.TestCase):
@@ -46,12 +42,12 @@ def test_add_custom_row_view_to_registry(self):
             ],
         }
 
-        # To make schema validation pass during test, we need to register a dummy view adapter
-        # so the vocabulary finds it when checking the 'row_type' value constraints
+        # To make schema validation pass during test, we need to register a dummy view
+        # adapter so the vocabulary finds it when checking 'row_type' value constraints
+        from cs_dynamicpages.content.dynamic_page_row import IDynamicPageRow
         from zope.component import getSiteManager
         from zope.interface import Interface
         from zope.publisher.interfaces.browser import IBrowserRequest
-        from cs_dynamicpages.content.dynamic_page_row import IDynamicPageRow
 
         class DummyView:
             pass
@@ -80,7 +76,6 @@ class DummyView:
 
         # Test vocabulary behavior
         from zope.schema.interfaces import IVocabularyFactory
-        from zope.component import getUtility
 
         vocab_factory = getUtility(IVocabularyFactory, name="cs_dynamicpages.RowType")
         vocab = vocab_factory(self.portal)

src/cs_dynamicpages/tests/how_tos/test_using_query_columns.py

@@ -1,10 +1,10 @@
-import unittest
+from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
 from plone import api
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
 from zope.component import getMultiAdapter
 
-from cs_dynamicpages.testing import CS_DYNAMICPAGES_INTEGRATION_TESTING
+import unittest
 
 
 class TestHowToUsingQueryColumns(unittest.TestCase):
@@ -100,5 +100,5 @@ def test_configure_query_columns(self):
 
         # It should also contain the layout class (e.g. Bootstrap grid col-*)
         # based on columns="3". Let's check if the generic class mapping handles it.
-        # It could be 'col-md-4' or 'row-cols-md-3' depending on the exact implementation.
-        # But for the how-to, we just verify it exists and renders.
+        # It could be 'col-md-4' or 'row-cols-md-3' depending on the exact
+        # implementation. But for the how-to, we just verify it exists and renders.