diff --git a/.github/pytest.json b/.github/pytest.json new file mode 100644 index 00000000..7f010d1e --- /dev/null +++ b/.github/pytest.json @@ -0,0 +1,23 @@ +{ + "problemMatcher": [ + { + "owner": "pytest-warnings", + "severity": "warning", + "pattern": [ + { + "regexp": "^=+ warnings summary =+$" + }, + { + "regexp": "^(?.+?):(?\\d+)$", + "file": 1, + "line": 2 + }, + { + "regexp": "^ (?.+)$", + "message": 1, + "loop": true + } + ] + } + ] +} diff --git a/.github/sphinx.json b/.github/sphinx.json new file mode 100644 index 00000000..2f12378d --- /dev/null +++ b/.github/sphinx.json @@ -0,0 +1,38 @@ +{ + "problemMatcher": [ + { + "owner": "sphinx-docstring", + "pattern": [ + { + "regexp": "^(?.+?):(?.*? (?WARNING|ERROR): .+)$", + "file": 1, + "severity": 3, + "message": 2 + } + ] + }, + { + "owner": "sphinx-doctest", + "pattern": [ + { + "regexp": "^File \\\"(?.+?)\\\", line (?\\d+|\\?), (?.*$)", + "file": 1, + "line": 2, + "message": 3 + } + ] + }, + { + "owner": "sphinx-extension", + "pattern": [ + { + "regexp": "^(?WARNING|ERROR): (?\\S+): (?.+)(?)$", + "severity": 1, + "code": 2, + "message": 3, + "file": 4 + } + ] + } + ] +} diff --git a/.github/workflows/pyleco_CI.yml b/.github/workflows/pyleco_CI.yml new file mode 100644 index 00000000..3e8ed1b3 --- /dev/null +++ b/.github/workflows/pyleco_CI.yml @@ -0,0 +1,144 @@ +name: PyLECO CI +on: + push: + branches: + - main + pull_request: + +jobs: + docs_lint: + name: Docs and Linting + runs-on: "ubuntu-latest" + defaults: + run: + shell: bash -l {0} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install pyleco requirements + uses: mamba-org/setup-micromamba@v1 + with: + environment-file: environment.yml + cache-environment-key: pylatest-ubuntu-latest-mamba-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + cache-downloads: false + - name: Python and Mamba version + run: | + python --version + micromamba info + - name: Lint with ruff + uses: chartboost/ruff-action@v1 + with: + args: --extend-select=E9,F63,F7,F82 --show-source + - uses: ammaraskar/sphinx-problem-matcher@master + - name: Generate docs + if: always() # run even if the previous step failed + working-directory: ./docs + run: | + echo "::add-matcher::.github/sphinx.json" + make html SPHINXOPTS="-W --keep-going" + - name: Run doctests + if: always() # run even if the previous step failed + working-directory: ./docs + run: | + echo "::add-matcher::.github/sphinx.json" + make doctest SPHINXOPTS="-W --keep-going" + type_checking: + name: Static Type Checking + runs-on: "ubuntu-latest" + defaults: + run: + shell: bash -l {0} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install pyleco requirements + uses: mamba-org/setup-micromamba@v1 + with: + environment-file: environment.yml + cache-environment-key: pylatest-ubuntu-latest-mamba-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + cache-downloads: false + - name: Python version + run: python --version + - name: Install mypy + run: pip install mypy + - name: Run mypy + run: mypy . + test_coverage: + name: Code Coverage + runs-on: "ubuntu-latest" + defaults: + run: + shell: bash -l {0} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install pyleco requirements + uses: mamba-org/setup-micromamba@v1 + with: + environment-file: environment.yml + cache-environment-key: pylatest-ubuntu-latest-mamba-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + cache-downloads: false + - name: Python version + run: python --version + - name: Install Pyleco + # If the pytest problem matcher stops working because of bad paths, do an editable install + run: pip install -e .[dev] # editable for covtest + - name: Test for Coverage + run: pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=pyleco | tee pytest-coverage.txt + - name: Pytest Coverage Comment + uses: MishaKav/pytest-coverage-comment@main + with: + pytest-coverage-path: ./pytest-coverage.txt + title: Coverage Report + badge-title: PyLECO Coverage + hide-badge: false + hide-report: false + create-new-comment: false + hide-comment: false + report-only-changed-files: false + remove-link-from-badge: false + unique-id-for-comment: python3.8 + junitxml-path: ./pytest.xml + junitxml-title: Coverage Summary + test: + name: Python ${{ matrix.python-version }}, ${{ matrix.os }} + runs-on: ${{ matrix.os }} + defaults: + run: + shell: bash -l {0} + strategy: + fail-fast: true + matrix: + os: ["ubuntu-latest", "macos-latest", "windows-latest"] + python-version: ["3.10", "3.11"] + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: Install pyleco requirements + uses: mamba-org/setup-micromamba@v1 + with: + environment-file: environment.yml + create-args: python=${{ matrix.python-version }} + cache-environment-key: py${{ matrix.python-version }}-${{ matrix.os }}-mamba-${{ env.CACHE_NUMBER }}-${{ hashFiles('environment.yml') }} + cache-downloads: false + - name: Python version + run: python --version + - name: Install Pyleco + # If the pytest problem matcher stops working because of bad paths, do an editable install + run: pip install .[dev] + - name: Pyleco version + run: python -c "import pyleco;print(pyleco.__version__)" + - name: Run pytest with xvfb + if: runner.os == 'Linux' + run: | + echo "::add-matcher::.github/pytest.json" + xvfb-run -a pytest + - name: Run pytest + if: runner.os != 'Linux' + run: | + echo "::add-matcher::.github/pytest.json" + pytest diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..97c82179 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PyMeasure.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyMeasure.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/PyMeasure" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyMeasure" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..eb5a78bd --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,272 @@ +# mypy: ignore-errors +# +# PyLECO documentation build configuration file, created by +# sphinx-quickstart on Mon Apr 6 13:06:00 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. + +import sys +import os + +sys.path.insert(0, os.path.abspath('..')) # Allow modules to be found +from pyleco import __version__ + +# Include Read the Docs formatting +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()] + +# 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.autosummary', 'sphinx.ext.doctest' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +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 = 'PyLECO' +copyright = '2023, PyLECO Developers' + +# 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. +# +release = __version__ +version = '.'.join(release.split('.')[:3]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# 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 + + +# -- 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 = 'sphinx_rtd_theme' + +# 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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PyLECOdoc' + +# -- 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': '', +} + +# 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 = [ + ('index', 'PyLECO.tex', 'PyLECO Documentation', + 'PyLECO Developers', '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 = [ + ('index', 'pyleco', 'PyLECO Documentation', + ['PyLECO Developers'], 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 = [ + ('index', 'PyLECO', 'PyLECO Documentation', + 'PyLECO Developers', 'PyLECO', 'Python implementation of the Laboratory Experiment COntrol (LECO) protocol.', + '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 + +# Automatically mock optional packages +# autodoc_mock_imports = ['zmq'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..8d0c7901 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,3 @@ +###### +PyLECO +###### diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..aefe0b35 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,242 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\PyMeasure.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\PyMeasure.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %BUILDDIR%/.. + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/environment.yml b/environment.yml index 5f5bb44e..945da579 100644 --- a/environment.yml +++ b/environment.yml @@ -2,12 +2,16 @@ name: pyleco channels: - conda-forge dependencies: - - pyzmq=25.0.0 + - pyzmq=25.1.0 + - pip # don't pin, to gain newest conda compatibility fixes + - pip: + - jsonrpc2-pyclient==2.2.12 + - openrpc==6.3.17 + - uuid7==0.1.0 # Development dependencies below - pytest=7.2.0 + - pytest-cov=4.1.0 + - pytest-runner=6.0.0 - setuptools_scm # don't pin, to get newest features - - sphinx=6.1.3 - - sphinx_rtd_theme=1.0.0 - # - pip # don't pin, to gain newest conda compatibility fixes - # - pip: - # - xxx + - sphinx=5.3.0 + - sphinx_rtd_theme=1.2.2 diff --git a/pyleco/__init__.py b/pyleco/__init__.py index e69de29b..a5c01b1f 100644 --- a/pyleco/__init__.py +++ b/pyleco/__init__.py @@ -0,0 +1,51 @@ +# +# This file is part of the PyLECO package. +# +# Copyright (c) 2023-2023 PyLECO Developers +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +# + +import warnings + +# Maximally flexible approach to obtain version numbers, based on this approach: +# https://github.com/pypa/setuptools_scm/issues/143#issuecomment-672878863 +# Sadly, this does not work with editable installs, which bake in version info on installation. +# see also https://github.com/pyusb/pyusb/pull/307#issuecomment-650797688 +try: + # If a user has setuptools_scm installed, assume they want the most up to date version string. + # Alternatively, we could use a dummy dev module that is never packaged whose presence signals + # that we are in an editable install/repo, see https://github.com/pycalphad/pycalphad/pull/341 + import setuptools_scm # type: ignore + __version__ = setuptools_scm.get_version(root='..', relative_to=__file__) + del setuptools_scm +except (ImportError, LookupError): # pragma: no cover + # Setuptools_scm was not found, or it could not find a version, so use installation metadata. + from importlib.metadata import version, PackageNotFoundError + try: + __version__ = version("pyleco") + # Alternatively, if the current approach is too slow, we could add + # 'write_to = "pyleco/_version.py"' in pyproject.toml and use the generated file here: + # from ._version import version as __version__ + except PackageNotFoundError: + warnings.warn('Could not find pyleco version, it does not seem to be installed. ' + 'Either install it (editable or full) or install setuptools_scm') + __version__ = '0.0.0' + finally: + del version, PackageNotFoundError diff --git a/pyleco/core/message.py b/pyleco/core/message.py index 016c68d9..ecda04be 100644 --- a/pyleco/core/message.py +++ b/pyleco/core/message.py @@ -23,7 +23,7 @@ # from json import JSONDecodeError -from typing import Any, Optional, Self +from typing import Any, Optional from . import VERSION_B @@ -81,7 +81,7 @@ def __init__(self, receiver: bytes | str, sender: bytes | str = b"", @classmethod def from_frames(cls, version: bytes, receiver: bytes, sender: bytes, header: bytes, - *payload: bytes) -> Self: + *payload: bytes): # -> typing.Self for py>=3.11 """Create a message from a frames list, for example after reading from a socket. .. code:: diff --git a/pyleco/core/rpc_generator.py b/pyleco/core/rpc_generator.py index d18320ef..98408fba 100644 --- a/pyleco/core/rpc_generator.py +++ b/pyleco/core/rpc_generator.py @@ -24,7 +24,7 @@ from typing import Any -from jsonrpc2pyclient._irpcclient import IRPCClient +from jsonrpc2pyclient._irpcclient import IRPCClient # type: ignore class RPCGenerator(IRPCClient): @@ -45,4 +45,4 @@ def get_result_from_response(self, data: bytes | str) -> Any: def clear_id_list(self) -> None: """Reset the list of created ids.""" - self._ids = {} + self._ids: dict[int, int] = {} diff --git a/pyleco/core/serialization.py b/pyleco/core/serialization.py index f02bd9dc..075afa2a 100644 --- a/pyleco/core/serialization.py +++ b/pyleco/core/serialization.py @@ -25,7 +25,7 @@ import json from typing import Optional, NamedTuple -from uuid_extensions import uuid7 # as long as uuid does not yet support UUIDv7 +from uuid_extensions import uuid7 # type: ignore # as long as uuid does not yet support UUIDv7 from jsonrpcobjects.objects import (RequestObject, RequestObjectParams, ResultResponseObject, ErrorResponseObject, diff --git a/pyleco/errors.py b/pyleco/errors.py index 196d962f..1cbf2310 100644 --- a/pyleco/errors.py +++ b/pyleco/errors.py @@ -30,11 +30,12 @@ # -32000 to -32099 Server error reserved for implementation-defined server-errors # TODO define valid error codes: Proposal: -# Routing errors (Coordinator) between -32000 and -32009 -NOT_SIGNED_IN = ErrorObject(code=-32000, message="You did not sign in!") -DUPLICATE_NAME = ErrorObject(code=-32001, message="The name is already taken.") -NODE_UNKNOWN = ErrorObject(code=-32002, message="Node is not known.") -RECEIVER_UNKNOWN = ErrorObject(code=-32003, message="Receiver is not in addresses list.") +# general error: -32000 +# Routing errors (Coordinator) between -32090 and -32099 +NOT_SIGNED_IN = ErrorObject(code=-32090, message="You did not sign in!") +DUPLICATE_NAME = ErrorObject(code=-32091, message="The name is already taken.") +NODE_UNKNOWN = ErrorObject(code=-32092, message="Node is not known.") +RECEIVER_UNKNOWN = ErrorObject(code=-32093, message="Receiver is not in addresses list.") def generate_error_with_data(error: ErrorObject, data: Any) -> ErrorObjectData: diff --git a/pyproject.toml b/pyproject.toml index 405e9fc1..a5bc9ec2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,15 +16,16 @@ classifiers = [ requires-python = ">=3.10" dependencies = [ - "pyzmq", - "openrpc", - "jsonrpc2-pyclient", - "uuid7", + "pyzmq >= 22.3.0", + "openrpc >= 6.3.17", + "jsonrpc2-pyclient >= 2.2.12", + "uuid7 >= 0.1.0", ] [project.optional-dependencies] dev = [ 'pytest', + 'pytest-cov', 'sphinx', 'sphinx_rtd_theme', ] @@ -39,3 +40,35 @@ build-backend = "setuptools.build_meta" [tool.setuptools_scm] # write_to = "pyleco/_version.py" + +[tool.black] +line-length = 100 + +[tool.isort] +profile = "black" + +[tool.ruff] +select = ["E", "F", "W"] +line-length = 100 +exclude = [ + ".git", + ".venv", + "__pypackages__", + "__pycache__", + "build", + "dist", + "docs/conf.py", +] + +[tool.ruff.per-file-ignores] +"__init__.py" = ["F401"] + +[mypy] + +[tool.coverage.run] +branch = true +omit = [ + # Omit LECO definitions + "pyleco/errors.py", + "pyleco/core/leco_protocols.py", +]