Merge pull request #17 from pymor/precommit

Pre-commit setup and formatting/linting fixups

Author: renefritze

.ci/make_env_file.py

@@ -3,13 +3,14 @@
 import os
 from os.path import expanduser
 from shlex import quote
+
 home = expanduser("~")
 
-prefixes = os.environ.get('ENV_PREFIXES', 'TRAVIS CI encrypt TOKEN TESTS').split(' ')
-blacklist = ['TRAVIS_COMMIT_MESSAGE']
-env_file = os.environ.get('ENV_FILE', os.path.join(home, 'env'))
-with open(env_file, 'wt') as env:
-    for k,v in os.environ.items():
+prefixes = os.environ.get("ENV_PREFIXES", "TRAVIS CI encrypt TOKEN TESTS").split(" ")
+blacklist = ["TRAVIS_COMMIT_MESSAGE"]
+env_file = os.environ.get("ENV_FILE", os.path.join(home, "env"))
+with open(env_file, "wt") as env:
+    for k, v in os.environ.items():
         for pref in prefixes:
             if k.startswith(pref) and k not in blacklist:
-                env.write('{}={}\n'.format(k,quote(v)))
+                env.write("{}={}\n".format(k, quote(v)))

.clang-format

@@ -0,0 +1,60 @@
+AlignAfterOpenBracket: true
+AlignConsecutiveAssignments: false
+AlignEscapedNewlines: Right
+AlignOperands: true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BasedOnStyle: Mozilla
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: NonAssignment
+BraceWrapping:
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+ColumnLimit: 120
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+IndentCaseLabels: true
+IndentPPDirectives: AfterHash
+IndentWidth: 2
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: true
+Language: Cpp
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: None
+PenaltyBreakComment: 60
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Left
+SortIncludes: false
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard: Cpp11
+TabWidth: 2
+UseTab: Never

.github/workflows/autosquash_check.yml

@@ -1,17 +1,24 @@
-# homepage: https://github.com/gaurav-nelson/github-action-markdown-link-check
-name: Check Markdown links
-
 on: [pull_request]
 
+name: Checks
+
 jobs:
-  markdown-link-check:
+  git:
+    name: Block Autosquash Commits
+    runs-on: ubuntu-latest
+    steps:
+      - name: Block Autosquash Commits
+        uses: xt0rted/block-autosquash-commits-action@v2
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+  source:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: markdown-link-check
       uses: gaurav-nelson/[email protected]
-
       with:
         use-verbose-mode: 'yes'
         check-modified-files-only: 'yes'
         base-branch: 'main'
+    - uses: pre-commit/[email protected]

.github/workflows/link_check.yml .github/workflows/checks.yml.github/workflows/link_check.yml renamed to .github/workflows/checks.yml

@@ -1,3 +1,4 @@
 /lib/CMakeLists.txt.user
 build
 CMakeLists.txt.user
+.idea

.gitignore

@@ -0,0 +1,24 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: debug-statements
+-   repo: https://github.com/psf/black
+    rev: 21.11b0
+    hooks:
+    -   id: black
+-   repo: https://github.com/pycqa/flake8
+    rev: 3.9.2
+    hooks:
+    -   id: flake8
+        exclude: "^(versioneer.py|src/pymor_dealii/version.py)"
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: 'v13.0.0'
+    hooks:
+    -   id: clang-format
+        exclude: "^lib/pybind11"

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+Requirements
+============
+
+`deal.II` with development headers
+
+Usage
+=====
+
+```
+git clone --recurse-submodules https://github.com/pymor/pymor-deal.II
+cd pymor-deal.II
+python -m pip install pymor
+python -m pip install -e .
+python test/demo.py
+```
+
+
+Development notes
+=================
+
+We have a `pre-commit` config that is also run/checked in CI.
+Python source is formatted with `black`.
+C++ source is formatted with `clang-format`.

README.md

@@ -2,7 +2,6 @@
 // Copyright 2013-2018 pyMOR developers and contributors. All rights reserved.
 // License: BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause)
 
-
 #include <deal.II/lac/dynamic_sparsity_pattern.h>
 #include <deal.II/lac/precondition.h>
 #include <deal.II/lac/solver_cg.h>
@@ -145,7 +144,7 @@ void bind_sparse_matrix(pybind11::module& module) {
       .def("vmult", &Matrix::template vmult<Vector, Vector>)
       .def("Tvmult", &Matrix::template Tvmult<Vector, Vector>)
       .def("get_sparsity_pattern", &Matrix::get_sparsity_pattern, py::return_value_policy::reference)
-      .def("add", (void (Matrix::*)(Number, const Matrix&)) & Matrix::template add<Number>)
+      .def("add", (void(Matrix::*)(Number, const Matrix&)) & Matrix::template add<Number>)
       .def("copy_from", (Matrix & (Matrix::*)(const Matrix&)) & Matrix::template copy_from<Number>)
       .def("cg_solve", cg_solve);
 }

lib/bindings.cc

@@ -98,8 +98,8 @@ inline void RightHandSide<dim>::vector_value(const Point<dim>& p, Vector<double>
   // If now the point <code>p</code> is in a circle (sphere) of radius 0.2
   // around one of these points, then set the force in x-direction to one,
   // otherwise to zero:
-  if ((static_cast<Point<dim>>(p - point_1).square() < 0.2 * 0.2)
-      || (static_cast<Point<dim>>(p - point_2).norm_square() < 0.2 * 0.2))
+  if ((static_cast<Point<dim>>(p - point_1).square() < 0.2 * 0.2) ||
+      (static_cast<Point<dim>>(p - point_2).norm_square() < 0.2 * 0.2))
     values(0) = 1;
   else
     values(0) = 0;

lib/rhs.hh

@@ -2,10 +2,10 @@
 # Copyright 2013-2018 pyMOR developers and contributors. All rights reserved.
 # License: BSD 2-Clause License (http://opensource.org/licenses/BSD-2-Clause)
 
-import pytest
 import numpy as np
 import pydealii_bindings as dealii
 
+
 def test_vector():
     v = dealii.Vector(10)
     u = dealii.Vector(10)
@@ -38,9 +38,10 @@ def test_vector():
     ddones[:] = np.ones((100,), np.double)
     npdd = np.array(ddones, copy=False)
     assert np.allclose(npdd, np.ones((100,), dtype=np.double))
-    npdd += 1.
-    ddones /= 2.
+    npdd += 1.0
+    ddones /= 2.0
     assert np.allclose(npdd, ddones)
 
+
 if __name__ == "__main__":
     test_vector()