From 21880a3cb81ca042ec2544b65bb58efd4a818177 Mon Sep 17 00:00:00 2001 From: Andrew Mirsky Date: Wed, 11 Jun 2025 13:09:09 -0400 Subject: [PATCH 1/3] ability to rebuild the 'latest' docs as of 2023-02-09T12:49:41.380973Z and 3912564bf10123bded92b8a8487169656180ae6a using default sphinx-generated conf.py --- .readthedocs.yaml | 13 ++ docs/conf.py | 321 +++------------------------------------------- requirements.txt | 26 ++++ 3 files changed, 54 insertions(+), 306 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..83c222f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ + version: 2 + + build: + os: ubuntu-24.04 + tools: + python: "3.8" + + sphinx: + configuration: docs/conf.py + + python: + install: + - requirements: requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 3283c91..f05b4fe 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,318 +1,27 @@ +# Configuration file for the Sphinx documentation builder. # -# aMQTT documentation build configuration file, created by -# sphinx-quickstart on Sun Nov 1 14:30:37 2015. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html -import os +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -# 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. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.doctest", - "sphinx.ext.intersphinx", - "sphinx.ext.todo", - "sphinx.ext.coverage", - "sphinx.ext.ifconfig", - "sphinx.ext.viewcode", -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = "index" - -# General information about the project. project = "amqtt" copyright = "2021, aMQTT contributers" author = "aMQTT contributers" +release = "0.10.2" -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -# The full version, including alpha/beta/rc tags. -release = "0.10.0-alpha.1" +extensions = [] -# The short X.Y version. -version = ".".join(release.split(".")[:2]) +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "default" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "aMQTTdoc" - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "aMQTT.tex", "aMQTT Documentation", "Nicolas Jouanin", "manual"), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "amqtt", "aMQTT Documentation", [author], 1)] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "aMQTT", - "aMQTT Documentation", - author, - "aMQTT", - "One line description of project.", - "Miscellaneous", - ), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- ReadTheDoc requirements and local template generation--------------------- - -# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] - # Override default css to get a larger width for local build - - def setup(app): - # app.add_javascript("custom.js") - app.add_stylesheet("theme_overrides.css") - - -else: - # Override default css to get a larger width for ReadTheDoc build - html_context = { - "css_files": [ - "https://media.readthedocs.org/css/sphinx_rtd_theme.css", - "https://media.readthedocs.org/css/readthedocs-doc-embed.css", - "_static/theme_overrides.css", - ], - } +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a50e503 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,26 @@ +alabaster==0.7.13 +babel==2.17.0 +certifi==2025.4.26 +charset-normalizer==3.4.2 +docutils==0.20.1 +idna==3.10 +imagesize==1.4.1 +importlib-metadata==8.5.0 +jinja2==3.1.6 +markupsafe==2.1.5 +packaging==25.0 +pygments==2.19.1 +pytz==2025.2 +requests==2.32.4 +snowballstemmer==3.0.1 +sphinx==7.1.2 +sphinx-rtd-theme==3.0.2 +sphinxcontrib-applehelp==1.0.4 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-jquery==4.1 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-serializinghtml==1.1.5 +urllib3==2.2.3 +zipp==3.20.2 From 364273e6842ccb7d6f01ff35e041ffa84d5f1e83 Mon Sep 17 00:00:00 2001 From: Andrew Mirsky Date: Sat, 14 Jun 2025 15:28:46 -0400 Subject: [PATCH 2/3] marking test for broker sys plugin as xfail, because it fails on github workflow but not locally --- tests/plugins/test_sys.py | 94 ++++++++++++++++++++------------------- 1 file changed, 48 insertions(+), 46 deletions(-) diff --git a/tests/plugins/test_sys.py b/tests/plugins/test_sys.py index 3b0d5be..9096825 100644 --- a/tests/plugins/test_sys.py +++ b/tests/plugins/test_sys.py @@ -13,49 +13,51 @@ from amqtt.mqtt.constants import QOS_0 logger = logging.getLogger(__name__) # test broker sys -# @pytest.mark.asyncio -# async def test_broker_sys_plugin() -> None: -# -# class MockEntryPoints: -# -# def select(self, group) -> list[EntryPoint]: -# match group: -# case 'tests.mock_plugins': -# return [ -# EntryPoint(name='BrokerSysPlugin', group='tests.mock_plugins', value='amqtt.plugins.sys.broker:BrokerSysPlugin'), -# ] -# case _: -# return list() -# -# -# with patch("amqtt.plugins.manager.entry_points", side_effect=MockEntryPoints) as mocked_mqtt_publish: -# -# config = { -# "listeners": { -# "default": {"type": "tcp", "bind": "127.0.0.1:1883", "max_connections": 10}, -# }, -# 'sys_interval': 1 -# } -# -# broker = Broker(plugin_namespace='tests.mock_plugins', config=config) -# await broker.start() -# client = MQTTClient() -# await client.connect("mqtt://127.0.0.1:1883/") -# await client.subscribe([("$SYS/broker/uptime", QOS_0),]) -# await client.publish('test/topic', b'my test message') -# await asyncio.sleep(2) -# sys_msg_count = 0 -# try: -# while True: -# message = await client.deliver_message(timeout_duration=0.5) -# if '$SYS' in message.topic: -# sys_msg_count += 1 -# except asyncio.TimeoutError: -# pass -# -# logger.warning(f">>> sys message: {message.topic} - {message.data}") -# await client.disconnect() -# await broker.shutdown() -# -# -# assert sys_msg_count > 1 +@pytest.mark.asyncio +@pytest.mark.xfail( + reason="see https://github.com/Yakifo/aio-amqtt/issues/215", + strict=False, +) +async def test_broker_sys_plugin() -> None: + + class MockEntryPoints: + + def select(self, group) -> list[EntryPoint]: + match group: + case 'tests.mock_plugins': + return [ + EntryPoint(name='BrokerSysPlugin', group='tests.mock_plugins', value='amqtt.plugins.sys.broker:BrokerSysPlugin'), + ] + case _: + return list() + + + with patch("amqtt.plugins.manager.entry_points", side_effect=MockEntryPoints) as mocked_mqtt_publish: + + config = { + "listeners": { + "default": {"type": "tcp", "bind": "127.0.0.1:1883", "max_connections": 10}, + }, + 'sys_interval': 1 + } + + broker = Broker(plugin_namespace='tests.mock_plugins', config=config) + await broker.start() + client = MQTTClient() + await client.connect("mqtt://127.0.0.1:1883/") + await client.subscribe([("$SYS/broker/uptime", QOS_0),]) + await client.publish('test/topic', b'my test message') + await asyncio.sleep(2) + sys_msg_count = 0 + try: + while True: + message = await client.deliver_message(timeout_duration=1) + if '$SYS' in message.topic: + sys_msg_count += 1 + except asyncio.TimeoutError: + pass + + await client.disconnect() + await broker.shutdown() + + assert sys_msg_count > 1 From 4729166d9983f49c5ca93d748051baef20ffe841 Mon Sep 17 00:00:00 2001 From: Andrew Mirsky Date: Sat, 14 Jun 2025 15:39:39 -0400 Subject: [PATCH 3/3] lint fix --- tests/plugins/test_sys.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/plugins/test_sys.py b/tests/plugins/test_sys.py index 9096825..30e4f95 100644 --- a/tests/plugins/test_sys.py +++ b/tests/plugins/test_sys.py @@ -9,7 +9,6 @@ from amqtt.broker import Broker from amqtt.client import MQTTClient from amqtt.mqtt.constants import QOS_0 - logger = logging.getLogger(__name__) # test broker sys