Merge pull request #155 from davidhewitt/fmt-black-ci

ci: check black formatting

Author: davidhewitt

.github/workflows/ci.yml

@@ -6,6 +6,20 @@ on:
   pull_request:
 
 jobs:
+  fmt:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+
+      - run: pip install black
+
+      - run: black --check .
+
   build:
     name:  ${{ matrix.python-version }} ${{ matrix.platform.os }}-${{ matrix.platform.python-architecture }}
     runs-on: ${{ matrix.platform.os }}

docs/conf.py

@@ -12,9 +12,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'setuptools-rust'
-copyright = '2021, The PyO3 Contributors'
-author = 'The PyO3 Contributors'
+project = "setuptools-rust"
+copyright = "2021, The PyO3 Contributors"
+author = "The PyO3 Contributors"
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,28 +31,28 @@
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- 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'
+html_theme = "sphinx_rtd_theme"
 
 # 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']
+html_static_path = ["_static"]
 
 html_theme_options = {
-    'prev_next_buttons_location': None,
+    "prev_next_buttons_location": None,
 }
 
 # -- Custom HTML link transformation to make documentation links relative --
@@ -62,29 +62,32 @@
 
 from sphinx.transforms import SphinxTransform
 
-DOCS_URL = 'https://setuptools-rust.readthedocs.io/en/latest/'
+DOCS_URL = "https://setuptools-rust.readthedocs.io/en/latest/"
+
 
 class RelativeDocLinks(SphinxTransform):
 
     default_priority = 750
 
     def apply(self):
         from docutils.nodes import reference, Text
+
         baseref = lambda o: (
-            isinstance(o, reference) and
-            o.get('refuri', '').startswith(DOCS_URL))
-        basetext = lambda o: (
-            isinstance(o, Text) and o.startswith(DOCS_URL))
+            isinstance(o, reference) and o.get("refuri", "").startswith(DOCS_URL)
+        )
+        basetext = lambda o: (isinstance(o, Text) and o.startswith(DOCS_URL))
         for node in self.document.traverse(baseref):
-            target = node['refuri'].replace(DOCS_URL, "", 1)
-            node.replace_attr('refuri', target)
+            target = node["refuri"].replace(DOCS_URL, "", 1)
+            node.replace_attr("refuri", target)
             for t in node.traverse(basetext):
                 t1 = Text(t.replace(DOCS_URL, "", 1), t.rawsource)
                 t.parent.replace(t, t1)
         return
 
+
 # end of class
 
+
 def setup(app):
     app.add_transform(RelativeDocLinks)
     return

examples/html-py-ever/setup.py

@@ -19,10 +19,7 @@
         "Operating System :: MacOS :: MacOS X",
     ],
     packages=["html_py_ever"],
-    install_requires=[
-        "beautifulsoup4",
-        "lxml"
-    ],
+    install_requires=["beautifulsoup4", "lxml"],
     rust_extensions=[RustExtension("html_py_ever.html_py_ever")],
     include_package_data=True,
     zip_safe=False,

examples/html-py-ever/test/run_all.py

@@ -21,7 +21,7 @@ def rust(filename: str) -> Tuple[int, float, float]:
 
 def python(filename: str, parser: str) -> Tuple[int, float, float]:
     start_load = perf_counter()
-    with open(filename, encoding='utf8') as fp:
+    with open(filename, encoding="utf8") as fp:
         soup = BeautifulSoup(fp, parser)
 
     end_load = perf_counter()

examples/html-py-ever/test/test_parsing.py

@@ -16,7 +16,7 @@ def rust(filename: str) -> Document:
 
 
 def python(filename: str) -> BeautifulSoup:
-    with open(filename, encoding='utf8') as fp:
+    with open(filename, encoding="utf8") as fp:
         soup = BeautifulSoup(fp, "html.parser")
 
     return soup

examples/html-py-ever/test/test_selector.py

@@ -18,6 +18,6 @@ def test_bench_selector_rust(benchmark, filename):
 
 @pytest.mark.parametrize("filename", HTML_FILES)
 def test_bench_selector_python(benchmark, filename):
-    with open(filename, encoding='utf8') as fp:
+    with open(filename, encoding="utf8") as fp:
         soup = BeautifulSoup(fp, "html.parser")
     benchmark(soup.select, "a[href]")

examples/namespace_package/setup.py

@@ -3,9 +3,16 @@
 
 
 setup(
-    name='namespace_package',
+    name="namespace_package",
     version="0.1.0",
-    packages=find_namespace_packages(include=['namespace_package.*']),
+    packages=find_namespace_packages(include=["namespace_package.*"]),
     zip_safe=False,
-    rust_extensions=[RustExtension("namespace_package.rust", path="Cargo.toml", binding=Binding.PyO3, debug=False)],
+    rust_extensions=[
+        RustExtension(
+            "namespace_package.rust",
+            path="Cargo.toml",
+            binding=Binding.PyO3,
+            debug=False,
+        )
+    ],
 )

examples/namespace_package/tests/test_namespace_package.py

@@ -2,8 +2,8 @@
 
 
 def test_rust():
-	assert rust.rust_func() == 14
+    assert rust.rust_func() == 14
 
 
 def test_cffi():
-	assert python.python_func() == 15
+    assert python.python_func() == 15

examples/rust_with_cffi/cffi_module.py

@@ -2,11 +2,16 @@
 
 
 ffi = cffi.FFI()
-ffi.cdef("""
+ffi.cdef(
+    """
 int cffi_func(void);
-""")
-ffi.set_source("rust_with_cffi.cffi", """
+"""
+)
+ffi.set_source(
+    "rust_with_cffi.cffi",
+    """
 int cffi_func(void) {
 	return 15;
 }
-""")
+""",
+)

examples/rust_with_cffi/tests/test_rust_with_cffi.py

@@ -3,8 +3,8 @@
 
 
 def test_rust():
-	assert rust.rust_func() == 14
+    assert rust.rust_func() == 14
 
 
 def test_cffi():
-	assert lib.cffi_func() == 15
+    assert lib.cffi_func() == 15