From 59266ba88878deed690ce62728b2297380980ae1 Mon Sep 17 00:00:00 2001 From: delucchi-cmu Date: Wed, 9 Aug 2023 10:43:14 -0400 Subject: [PATCH 1/3] Initial refactor to support testing --- .copier-answers.yml | 4 +- .github/workflows/build-documentation.yml | 34 ------ .pre-commit-config.yaml | 30 +---- .readthedocs.yml | 22 ---- README.md | 12 +- docs/Makefile | 31 ----- docs/conf.py | 47 ------- docs/index.rst | 13 -- docs/notebooks.rst | 6 - docs/notebooks/README.md | 1 - docs/notebooks/intro_notebook.ipynb | 111 ----------------- docs/requirements.txt | 9 -- pyproject.toml | 14 +-- src/lf_asv_formatter/__main__.py | 116 +----------------- src/lf_asv_formatter/asv_formatter.py | 122 +++++++++++++++++++ tests/conftest.py | 64 ++++++++++ tests/data/expected_output | 9 ++ tests/data/original_output | 11 ++ tests/lf_asv_formatter/conftest.py | 0 tests/lf_asv_formatter/test_asv_formatter.py | 12 ++ 20 files changed, 228 insertions(+), 440 deletions(-) delete mode 100644 .github/workflows/build-documentation.yml delete mode 100644 .readthedocs.yml delete mode 100644 docs/Makefile delete mode 100644 docs/conf.py delete mode 100644 docs/index.rst delete mode 100644 docs/notebooks.rst delete mode 100644 docs/notebooks/README.md delete mode 100644 docs/notebooks/intro_notebook.ipynb delete mode 100644 docs/requirements.txt create mode 100644 src/lf_asv_formatter/asv_formatter.py create mode 100644 tests/conftest.py create mode 100644 tests/data/expected_output create mode 100644 tests/data/original_output delete mode 100644 tests/lf_asv_formatter/conftest.py create mode 100644 tests/lf_asv_formatter/test_asv_formatter.py diff --git a/.copier-answers.yml b/.copier-answers.yml index 97396ab..a146a82 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -5,8 +5,8 @@ author_email: Lincc-frameworks-team@lists.lsst.org author_name: LINCC Frameworks Team create_example_module: false custom_install: true -include_docs: true -include_notebooks: true +include_docs: false +include_notebooks: false mypy_type_checking: none package_name: lf_asv_formatter preferred_linter: black diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml deleted file mode 100644 index e329f57..0000000 --- a/.github/workflows/build-documentation.yml +++ /dev/null @@ -1,34 +0,0 @@ -# This workflow will install Python dependencies, build the package and then build the documentation. - -name: Build documentation - - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - name: Set up Python 3.10 - uses: actions/setup-python@v4 - with: - python-version: '3.10' - - name: Install dependencies - run: | - sudo apt-get update - python -m pip install --upgrade pip - if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi - pip install . - - name: Install notebook requirements - run: | - sudo apt-get install pandoc - - name: Build docs - run: | - sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d08084b..6499eed 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -79,32 +79,4 @@ repos: # supported by your project here, or alternatively use # pre-commit's default_language_version, see # https://pre-commit.com/#top_level-default_language_version - language_version: python3.10 - - - # Make sure Sphinx can build the documentation while explicitly omitting - # notebooks from the docs, so users don't have to wait through the execution - # of each notebook or each commit. By default, these will be checked in the - # GitHub workflows. - - repo: local - hooks: - - id: sphinx-build - name: Build documentation with Sphinx - entry: sphinx-build - language: system - always_run: true - exclude_types: [file, symlink] - args: - [ - "-M", # Run sphinx in make mode, so we can use -D flag later - # Note: -M requires next 3 args to be builder, source, output - "html", # Specify builder - "./docs", # Source directory of documents - "./_readthedocs", # Output directory for rendered documents - "-T", # Show full trace back on exception - "-E", # Don't use saved env; always read all files - "-d", # Flag for cached environment and doctrees - "./docs/_build/doctrees", # Directory - "-D", # Flag to override settings in conf.py - "exclude_patterns=notebooks/*", # Exclude our notebooks from pre-commit - ] + language_version: python3.10 \ No newline at end of file diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 79bfc27..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,22 +0,0 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -build: - os: ubuntu-22.04 - tools: - python: "3.10" - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Optionally declare the Python requirements required to build your docs -python: - install: - - requirements: docs/requirements.txt - - method: pip - path: . diff --git a/README.md b/README.md index 6fcf564..366edf6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,6 @@ -# lf-asv-formatter +# ASV Formatter [![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/) -This project was automatically generated using the LINCC-Frameworks -[python-project-template](https://github.com/lincc-frameworks/python-project-template). - -A repository badge was added to show that this project uses the python-project-template, however it's up to -you whether or not you'd like to display it! - -For more information about the project template see the -[documentation](https://lincc-ppt.readthedocs.io/en/latest/). +Simple script to re-format the output of ASV (air-speed-velocity) benchmarking +outputs for use in github messages. \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index a5622f1..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,31 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -T -E -d _build/doctrees -D language=en -EXCLUDENB ?= -D exclude_patterns="notebooks/*","_build","**.ipynb_checkpoints" -SPHINXBUILD ?= sphinx-build -SOURCEDIR = . -BUILDDIR = ../_readthedocs/ - -.PHONY: help clean Makefile no-nb no-notebooks - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -# Build all Sphinx docs locally, except the notebooks -no-nb no-notebooks: - @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(EXCLUDENB) $(O) - -# Cleans up files generated by the build process -clean: - rm -r "_build/doctrees" - rm -r "$(BUILDDIR)" - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 5ecb469..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,47 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - - -import os -import sys - -import autoapi -from importlib.metadata import version - -# Define path to the code to be documented **relative to where conf.py (this file) is kept** -sys.path.insert(0, os.path.abspath('../src/')) - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = "lf-asv-formatter" -copyright = "2023, LINCC Frameworks Team" -author = "LINCC Frameworks Team" -release = version("lf-asv-formatter") -# for example take major/minor -version = ".".join(release.split(".")[:2]) - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = ["sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinx.ext.viewcode"] - -extensions.append("autoapi.extension") -extensions.append("nbsphinx") - -templates_path = [] -exclude_patterns = ['_build', '**.ipynb_checkpoints'] - -master_doc = "index" # This assumes that sphinx-build is called from the root directory -html_show_sourcelink = False # Remove 'view source code' from top of page (for html, not python) -add_module_names = False # Remove namespaces from class/method signatures - -autoapi_type = "python" -autoapi_dirs = ["../src"] -autoapi_ignore = ["*/__main__.py", "*/_version.py"] -autoapi_add_toc_tree_entry = False -autoapi_member_order = "bysource" - -html_theme = "sphinx_rtd_theme" diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index c782c62..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. lf_asv_formatter documentation main file. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to lf_asv_formatter's documentation! -======================================================================================== - -.. toctree:: - :hidden: - - Home page - API Reference - Notebooks diff --git a/docs/notebooks.rst b/docs/notebooks.rst deleted file mode 100644 index 7f7e544..0000000 --- a/docs/notebooks.rst +++ /dev/null @@ -1,6 +0,0 @@ -Notebooks -======================================================================================== - -.. toctree:: - - Introducing Jupyter Notebooks diff --git a/docs/notebooks/README.md b/docs/notebooks/README.md deleted file mode 100644 index a521ae1..0000000 --- a/docs/notebooks/README.md +++ /dev/null @@ -1 +0,0 @@ -Put your Jupyter notebooks here :) diff --git a/docs/notebooks/intro_notebook.ipynb b/docs/notebooks/intro_notebook.ipynb deleted file mode 100644 index 2e7779f..0000000 --- a/docs/notebooks/intro_notebook.ipynb +++ /dev/null @@ -1,111 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "id": "accepting-editor", - "metadata": { - "cell_marker": "\"\"\"" - }, - "source": [ - "# Introducing Jupyter Notebooks\n", - "\n", - "_(The example used here is JamesALeedham's notebook: [intro.ipynb](https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion/blob/master/docs/notebooks/intro.ipynb))_\n", - "\n", - "First, set up the environment:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "actual-thirty", - "metadata": {}, - "outputs": [], - "source": [ - "import matplotlib\n", - "import matplotlib.pyplot as pl\n", - "import numpy as np\n", - "\n", - "try:\n", - " from IPython import get_ipython\n", - " get_ipython().run_line_magic('matplotlib', 'inline')\n", - "except AttributeError:\n", - " print('Magic function can only be used in IPython environment')\n", - " matplotlib.use('Agg')\n", - "\n", - "pl.rcParams[\"figure.figsize\"] = [15, 8]" - ] - }, - { - "cell_type": "markdown", - "id": "coral-upper", - "metadata": { - "cell_marker": "\"\"\"", - "lines_to_next_cell": 1 - }, - "source": [ - "Then, define a function that creates a pretty graph:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "funded-protection", - "metadata": { - "lines_to_next_cell": 1 - }, - "outputs": [], - "source": [ - "def SineAndCosineWaves():\n", - " # Get a large number of X values for a nice smooth curve. Using Pi as np.sin requires radians...\n", - " x = np.linspace(0, 2 * np.pi, 180)\n", - " # Convert radians to degrees to make for a meaningful X axis (1 radian = 57.29* degrees)\n", - " xdeg = 57.29577951308232 * np.array(x)\n", - " # Calculate the sine of each value of X\n", - " y = np.sin(x)\n", - " # Calculate the cosine of each value of X\n", - " z = np.cos(x)\n", - " # Plot the sine wave in blue, using degrees rather than radians on the X axis\n", - " pl.plot(xdeg, y, color='blue', label='Sine wave')\n", - " # Plot the cos wave in green, using degrees rather than radians on the X axis\n", - " pl.plot(xdeg, z, color='green', label='Cosine wave')\n", - " pl.xlabel(\"Degrees\")\n", - " # More sensible X axis values\n", - " pl.xticks(np.arange(0, 361, 45))\n", - " pl.legend()\n", - " pl.show()" - ] - }, - { - "cell_type": "markdown", - "id": "thorough-cutting", - "metadata": { - "cell_marker": "\"\"\"" - }, - "source": [ - "Finally, call that function to display the graph:" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "imported-uruguay", - "metadata": {}, - "outputs": [], - "source": [ - "SineAndCosineWaves()" - ] - } - ], - "metadata": { - "jupytext": { - "cell_markers": "\"\"\"" - }, - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - } - }, - "nbformat": 4, - "nbformat_minor": 5 -} diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 5c0f7d8..0000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,9 +0,0 @@ -sphinx==6.1.3 -sphinx-rtd-theme==1.2.0 -sphinx-autoapi==2.0.1 -nbsphinx -ipython -jupytext -jupyter -matplotlib -numpy diff --git a/pyproject.toml b/pyproject.toml index 4f5f850..f47f6ce 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,7 +15,7 @@ classifiers = [ ] dynamic = ["version"] dependencies = [ - "ipykernel", # Support for Jupyter notebooks + "tabulate", # Used to prettify ASV output tables ] # On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes) @@ -24,19 +24,7 @@ dev = [ "pytest", "pytest-cov", # Used to report total code coverage "pre-commit", # Used to run checks before finalizing a git commit - "sphinx==6.1.3", # Used to automatically generate documentation - "sphinx-rtd-theme==1.2.0", # Used to render documentation - "sphinx-autoapi==2.0.1", # Used to automatically generate api documentation "black", # Used for static linting of files - # if you add dependencies here while experimenting in a notebook and you - # want that notebook to render in your documentation, please add the - # dependencies to ./docs/requirements.txt as well. - "nbconvert", # Needed for pre-commit check to clear output from Python notebooks - "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation - "ipython", # Also used in building notebooks into Sphinx - "matplotlib", # Used in sample notebook intro_notebook.ipynb - "numpy", # Used in sample notebook intro_notebook.ipynb - "tabulate", # Used to prettify ASV output tables ] [build-system] diff --git a/src/lf_asv_formatter/__main__.py b/src/lf_asv_formatter/__main__.py index 202bcca..d46a716 100644 --- a/src/lf_asv_formatter/__main__.py +++ b/src/lf_asv_formatter/__main__.py @@ -1,118 +1,8 @@ -import re +"""Main file to call from command line and github workflows.""" -from tabulate import tabulate - -output_file = "output" -output_table_style = "github" -max_num_rows = 10 - - -"""Typical ASV table file (before processing): - -All benchmarks: - - before after ratio - [fcd6c976] [bc939276] -
- 2.1k 2.1k 1.00 benchmarks.MemSuite.mem_list - failed 304±2ms n/a benchmarks.TimeSuite.time_iterkeys - 2.43±0.05μs 205±0.7ms 84400.48 benchmarks.TimeSuite.time_keys - 9.67±0.03μs 505±1ms 52177.14 benchmarks.TimeSuite.time_range - failed 1.01±0s n/a benchmarks.TimeSuite.time_xrange -""" - -"""Formatted ASV table file (github style): -| Before | After | Ratio | Method | -|-------------|-------------|----------|------------------------------------| -| [fcd6c976] | [bc939276] | | | -| 2.1k | 2.1k | 1.00 | benchmarks.MemSuite.mem_list | -| failed | 304±2ms | n/a | benchmarks.TimeSuite.time_iterkeys | -| 2.43±0.05μs | 205±0.7ms | 84400.48 | benchmarks.TimeSuite.time_keys | -| 9.67±0.03μs | 505±1ms | 52177.14 | benchmarks.TimeSuite.time_range | -| failed | 1.01±0s | n/a | benchmarks.TimeSuite.time_xrange | -""" - - -def format_asv_table_from_file(filename): - """Parses and formats a table generated by `asv compare`. - - Parameters - ---------- - filename : str - Name of the file containing the table. - - Returns - ------- - tuple of str - Headers and rows of the formatted table. - """ - headers = [] - table_data = [] - - with open(filename, "r") as file: - rows = parse_table_rows(file.readlines()) - headers = format_headers(rows[0]) - branch_data = [rows[1]] - bench_data = rows[2:] - num_results = min(max_num_rows, len(bench_data)) - table_data = remove_first_column(bench_data[:num_results]) - - return headers, branch_data + table_data - - -def parse_table_rows(rows): - """Splits the columns, for each row, by whitespace separator. - - Parameters - ---------- - rows : list of str - Lines read from a file. - - Returns - ------- - list of lists - List of columns for each row. The first three lines of the original - file are ignored as they do not contain useful information. - """ - return [re.split(r"\s+", row.strip()) for row in rows[3:]] - - -def format_headers(headers): - """Reads and capitalizes the table headers. - - Parameters - ---------- - headers : list of str - List of headers read from the file. - - Returns - ------- - list of str - Full list of capitalized table headers. - """ - headers.append("method") - return [header.capitalize() for header in headers] - - -def remove_first_column(lines): - """Discards the first column of the benchmarks table if it - does not contain useful information ("+" / "-" / "x"). - - Parameters - ---------- - lines : list of lists - Lines containing benchmark information. - - Returns - ------- - list of lists - Lines containing benchmark information. - """ - return [line[1:] if len(line) > 4 else line for line in lines] +from .asv_formatter import rewrite_file if __name__ == "__main__": - headers, rows = format_asv_table_from_file(output_file) - with open(output_file, "w") as file: - file.write(tabulate(rows, headers=headers, tablefmt=output_table_style)) + rewrite_file() diff --git a/src/lf_asv_formatter/asv_formatter.py b/src/lf_asv_formatter/asv_formatter.py new file mode 100644 index 0000000..6042c1e --- /dev/null +++ b/src/lf_asv_formatter/asv_formatter.py @@ -0,0 +1,122 @@ +"""Typical ASV table file (before processing): + +All benchmarks: + + before after ratio + [fcd6c976] [bc939276] +
+ 2.1k 2.1k 1.00 benchmarks.MemSuite.mem_list + failed 304±2ms n/a benchmarks.TimeSuite.time_iterkeys + 2.43±0.05μs 205±0.7ms 84400.48 benchmarks.TimeSuite.time_keys + 9.67±0.03μs 505±1ms 52177.14 benchmarks.TimeSuite.time_range + failed 1.01±0s n/a benchmarks.TimeSuite.time_xrange + +Formatted ASV table file (github style): +| Before | After | Ratio | Method | +|-------------|-------------|----------|------------------------------------| +| [fcd6c976] | [bc939276] | | | +| 2.1k | 2.1k | 1.00 | benchmarks.MemSuite.mem_list | +| failed | 304±2ms | n/a | benchmarks.TimeSuite.time_iterkeys | +| 2.43±0.05μs | 205±0.7ms | 84400.48 | benchmarks.TimeSuite.time_keys | +| 9.67±0.03μs | 505±1ms | 52177.14 | benchmarks.TimeSuite.time_range | +| failed | 1.01±0s | n/a | benchmarks.TimeSuite.time_xrange | +""" + +import re + +from tabulate import tabulate + +DEFAULT_OUTPUT_FILE = "output" +OUTPUT_TABLE_STYLE = "github" +MAX_NUM_ROWS = 10 + + +def rewrite_file(input_file=None, output_file=None): + """Read input file as ASV output, and write new file with github-formatted data.""" + if not input_file: + input_file = DEFAULT_OUTPUT_FILE + if not output_file: + output_file = DEFAULT_OUTPUT_FILE + + headers, rows = format_asv_table_from_file(input_file) + + with open(output_file, "w", encoding="utf-8") as file: + file.write(tabulate(rows, headers=headers, tablefmt=OUTPUT_TABLE_STYLE)) + + +def format_asv_table_from_file(filename): + """Parses and formats a table generated by `asv compare`. + + Parameters + ---------- + filename : str + Name of the file containing the table. + + Returns + ------- + tuple of str + Headers and rows of the formatted table. + """ + headers = [] + table_data = [] + + with open(filename, "r", encoding="utf-8") as file: + rows = parse_table_rows(file.readlines()) + headers = format_headers(rows[0]) + branch_data = [rows[1]] + bench_data = rows[2:] + num_results = min(MAX_NUM_ROWS, len(bench_data)) + table_data = remove_first_column(bench_data[:num_results]) + + return headers, branch_data + table_data + + +def parse_table_rows(rows): + """Splits the columns, for each row, by whitespace separator. + + Parameters + ---------- + rows : list of str + Lines read from a file. + + Returns + ------- + list of lists + List of columns for each row. The first three lines of the original + file are ignored as they do not contain useful information. + """ + return [re.split(r"\s+", row.strip()) for row in rows[3:]] + + +def format_headers(headers): + """Reads and capitalizes the table headers. + + Parameters + ---------- + headers : list of str + List of headers read from the file. + + Returns + ------- + list of str + Full list of capitalized table headers. + """ + headers.append("method") + return [header.capitalize() for header in headers] + + +def remove_first_column(lines): + """Discards the first column of the benchmarks table if it + does not contain useful information ("+" / "-" / "x"). + + Parameters + ---------- + lines : list of lists + Lines containing benchmark information. + + Returns + ------- + list of lists + Lines containing benchmark information. + """ + return [line[1:] if len(line) > 4 else line for line in lines] diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..b0114f4 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,64 @@ +import os + +import pytest + +# pylint: disable=missing-function-docstring, redefined-outer-name + +DATA_DIR_NAME = "data" + +TEST_DIR = os.path.dirname(__file__) + + +@pytest.fixture +def test_data_dir(): + return os.path.join(TEST_DIR, DATA_DIR_NAME) + + +@pytest.fixture +def original_output_path(): + return os.path.join(TEST_DIR, DATA_DIR_NAME, "original_output") + + +@pytest.fixture +def expected_output_path(): + return os.path.join(TEST_DIR, DATA_DIR_NAME, "expected_output") + + +@pytest.fixture +def assert_text_file_matches(): + def assert_text_file_matches(file_name, golden_file_name): + """Convenience method to read a text file and compare the contents, line for line. + + When file contents get even a little bit big, it can be difficult to see + the difference between an actual file and the expected contents without + increased testing verbosity. This helper compares files line-by-line, + using the provided strings or regular expressions. + + Notes: + Because we check strings as regular expressions, you may need to escape some + contents of `expected_lines`. + + Args: + expected_lines(:obj:`string array`) list of strings, formatted as regular expressions. + file_name (str): fully-specified path of the file to read + """ + + assert os.path.exists(golden_file_name), f"file not found [{golden_file_name}]" + with open(golden_file_name, "r", encoding="utf-8") as metadata_file: + golden_contents = metadata_file.readlines() + + assert os.path.exists(file_name), f"file not found [{file_name}]" + with open(file_name, "r", encoding="utf-8") as metadata_file: + contents = metadata_file.readlines() + + assert len(golden_contents) == len( + contents + ), f"files not the same length ({len(contents)} vs {len(golden_contents)})" + for i, expected in enumerate(golden_contents): + assert expected == contents[i], ( + f"files do not match at line {i+1} " f"(actual: [{contents[i]}] vs expected: [{expected}])" + ) + + metadata_file.close() + + return assert_text_file_matches diff --git a/tests/data/expected_output b/tests/data/expected_output new file mode 100644 index 0000000..4aad556 --- /dev/null +++ b/tests/data/expected_output @@ -0,0 +1,9 @@ +| Before | After | Ratio | Method | +|-------------|------------|----------|------------------------------------| +| [fcd6c976] | [bc939276] | | | +|
| | | | +| 2.1k | 2.1k | 1.00 | benchmarks.MemSuite.mem_list | +| failed | 304±2ms | n/a | benchmarks.TimeSuite.time_iterkeys | +| 2.43±0.05μs | 205±0.7ms | 84400.48 | benchmarks.TimeSuite.time_keys | +| 9.67±0.03μs | 505±1ms | 52177.14 | benchmarks.TimeSuite.time_range | +| failed | 1.01±0s | n/a | benchmarks.TimeSuite.time_xrange | \ No newline at end of file diff --git a/tests/data/original_output b/tests/data/original_output new file mode 100644 index 0000000..d7c382a --- /dev/null +++ b/tests/data/original_output @@ -0,0 +1,11 @@ + +All benchmarks: + + before after ratio + [fcd6c976] [bc939276] +
+ 2.1k 2.1k 1.00 benchmarks.MemSuite.mem_list + failed 304±2ms n/a benchmarks.TimeSuite.time_iterkeys + 2.43±0.05μs 205±0.7ms 84400.48 benchmarks.TimeSuite.time_keys + 9.67±0.03μs 505±1ms 52177.14 benchmarks.TimeSuite.time_range + failed 1.01±0s n/a benchmarks.TimeSuite.time_xrange \ No newline at end of file diff --git a/tests/lf_asv_formatter/conftest.py b/tests/lf_asv_formatter/conftest.py deleted file mode 100644 index e69de29..0000000 diff --git a/tests/lf_asv_formatter/test_asv_formatter.py b/tests/lf_asv_formatter/test_asv_formatter.py new file mode 100644 index 0000000..8cc959d --- /dev/null +++ b/tests/lf_asv_formatter/test_asv_formatter.py @@ -0,0 +1,12 @@ +import os + +from lf_asv_formatter.asv_formatter import rewrite_file + + +def test_rewrite_file(assert_text_file_matches, tmp_path, original_output_path, expected_output_path): + """Confirm that we write out the file with the expected formatting.""" + + output_file = os.path.join(tmp_path, "output_file") + rewrite_file(original_output_path, output_file) + + assert_text_file_matches(output_file, expected_output_path) From 7eebb98f797134d2133eca9dc7db2d1a7cf2a108 Mon Sep 17 00:00:00 2001 From: delucchi-cmu Date: Wed, 9 Aug 2023 10:46:37 -0400 Subject: [PATCH 2/3] copier update --- .copier-answers.yml | 3 +- .github/workflows/linting.yml | 5 +- .pre-commit-config.yaml | 36 +- pyproject.toml | 8 +- src/.pylintrc | 626 +++++++++++++++++++++++++++++++++ tests/.pylintrc | 627 ++++++++++++++++++++++++++++++++++ 6 files changed, 1288 insertions(+), 17 deletions(-) create mode 100644 src/.pylintrc create mode 100644 tests/.pylintrc diff --git a/.copier-answers.yml b/.copier-answers.yml index a146a82..06af369 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -6,10 +6,9 @@ author_name: LINCC Frameworks Team create_example_module: false custom_install: true include_docs: false -include_notebooks: false mypy_type_checking: none package_name: lf_asv_formatter -preferred_linter: black +preferred_linter: pylint project_license: MIT project_name: lf-asv-formatter use_gitlfs: none diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml index dfcf56b..0c907d7 100644 --- a/.github/workflows/linting.yml +++ b/.github/workflows/linting.yml @@ -31,6 +31,5 @@ jobs: if [ -f requirements.txt ]; then pip install -r requirements.txt; fi - name: Analyze code with linter - uses: psf/black@stable - with: - src: ./src + run: | + pylint -rn -sn --recursive=y ./src --rcfile=./src/.pylintrc diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6499eed..5b2a93b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -68,15 +68,41 @@ repos: files: ^(src|tests)/ - # Analyze the code style and report code that doesn't adhere. - - repo: https://github.com/psf/black - rev: 23.1.0 + # Analyze the src code style and report code that doesn't adhere. + - repo: local hooks: - - id: black + - id: pylint + name: pylint (python files in src/) + entry: pylint + language: system types: [python] files: ^(src|tests)/ # It is recommended to specify the latest version of Python # supported by your project here, or alternatively use # pre-commit's default_language_version, see # https://pre-commit.com/#top_level-default_language_version - language_version: python3.10 \ No newline at end of file + language_version: python3.10 + files: ^src/ + args: + [ + "-rn", # Only display messages + "-sn", # Don't display the score + "--rcfile=src/.pylintrc", + ] + # Analyze the tests code style and report code that doesn't adhere. + - repo: local + hooks: + - id: pylint + name: pylint (python files in tests/) + entry: pylint + language: system + types: [python] + files: ^tests/ + args: + [ + "-rn", # Only display messages + "-sn", # Don't display the score + "--rcfile=tests/.pylintrc", + ] + + diff --git a/pyproject.toml b/pyproject.toml index f47f6ce..1737d39 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -24,7 +24,7 @@ dev = [ "pytest", "pytest-cov", # Used to report total code coverage "pre-commit", # Used to run checks before finalizing a git commit - "black", # Used for static linting of files + "pylint", # Used for static linting of files ] [build-system] @@ -41,9 +41,3 @@ write_to = "src/lf_asv_formatter/_version.py" testpaths = [ "tests", ] - -[tool.black] -line-length = 110 - -[tool.isort] -profile = "black" diff --git a/src/.pylintrc b/src/.pylintrc new file mode 100644 index 0000000..ac138f1 --- /dev/null +++ b/src/.pylintrc @@ -0,0 +1,626 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. +ignore-patterns=_version.py + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.9 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + missing-module-docstring, + unnecessary-pass, + + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io diff --git a/tests/.pylintrc b/tests/.pylintrc new file mode 100644 index 0000000..c3cf2bf --- /dev/null +++ b/tests/.pylintrc @@ -0,0 +1,627 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths= + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. +ignore-patterns=_version.py + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.9 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1000 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + use-symbolic-message-instead, + missing-function-docstring, + redefined-outer-name, + protected-access, + missing-module-docstring, + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +#output-format= + +# Tells whether to display a full report or only the messages. +reports=no + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io From e9e45cca95e8078185db7b146445e3d14f1ed33f Mon Sep 17 00:00:00 2001 From: delucchi-cmu Date: Wed, 9 Aug 2023 10:48:00 -0400 Subject: [PATCH 3/3] omg that template --- .github/pull_request_template.md | 63 -------------------------------- 1 file changed, 63 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 76e043c..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,63 +0,0 @@ - - -## Change Description - -- [ ] My PR includes a link to the issue that I am addressing - - - -## Solution Description - - - - -## Code Quality -- [ ] I have read the Contribution Guide -- [ ] My code follows the code style of this project -- [ ] My code builds (or compiles) cleanly without any errors or warnings -- [ ] My code contains relevant comments and necessary documentation - -## Project-Specific Pull Request Checklists - - -### Bug Fix Checklist -- [ ] My fix includes a new test that breaks as a result of the bug (if possible) -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### New Feature Checklist -- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible) - -### Documentation Change Checklist -- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html) - -### Build/CI Change Checklist -- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this -- [ ] If this is a new CI setup, I have added the associated badge to the README - - - -### Other Change Checklist -- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html). -- [ ] I have updated the tutorial to highlight my new feature (if appropriate) -- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes -- [ ] My change includes a breaking change - - [ ] My change includes backwards compatibility and deprecation warnings (if possible)