more black

Author: tomvanmele

docs/conf.py

@@ -13,7 +13,7 @@
 import sphinx_compas_theme
 from sphinx.ext.napoleon.docstring import NumpyDocstring
 
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../src'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../src"))
 
 # -- General configuration ------------------------------------------------
 
@@ -24,14 +24,14 @@
 version = ".".join(release.split(".")[0:2])
 
 master_doc = "index"
-source_suffix = [".rst", ]
+source_suffix = [".rst"]
 templates_path = sphinx_compas_theme.get_autosummary_templates_path()
 exclude_patterns = []
 
-pygments_style   = "sphinx"
-show_authors     = True
+pygments_style = "sphinx"
+show_authors = True
 add_module_names = True
-language         = None
+language = None
 
 
 # -- Extension configuration ------------------------------------------------
@@ -69,7 +69,7 @@
     "rhinoscriptsyntax",
     "bpy",
     "bmesh",
-    "mathutils"
+    "mathutils",
 ]
 
 autodoc_default_options = {
@@ -83,7 +83,7 @@
 
 
 def skip(app, what, name, obj, would_skip, options):
-    if name.startswith('_'):
+    if name.startswith("_"):
         return True
     return would_skip
 
@@ -197,13 +197,13 @@ def linkcode_resolve(domain, info):
 html_theme_path = sphinx_compas_theme.get_html_theme_path()
 
 html_theme_options = {
-    "package_name"    : "compas_occ",
-    "package_title"   : project,
-    "package_version" : release,
-    "package_author"  : "compas-dev",
-    "package_docs"    : "https://compas.dev/compas_occ/",
-    "package_repo"    : "https://github.com/compas-dev/compas_occ",
-    "package_old_versions_txt": "https://compas.dev/compas_occ/doc_versions.txt"
+    "package_name": "compas_occ",
+    "package_title": project,
+    "package_version": release,
+    "package_author": "compas-dev",
+    "package_docs": "https://compas.dev/compas_occ/",
+    "package_repo": "https://github.com/compas-dev/compas_occ",
+    "package_old_versions_txt": "https://compas.dev/compas_occ/doc_versions.txt",
 }
 
 html_context = {}

docs/examples/surface_intersections_with_line.py

@@ -67,7 +67,9 @@
 view.add(Collection(intersections), pointsize=30, pointcolor=(0, 0, 1))
 
 for x in intersections:
-    view.add(Line(base, base + (x - base).scaled(1.2)), linewidth=1, linecolor=(0, 0, 1))
+    view.add(
+        Line(base, base + (x - base).scaled(1.2)), linewidth=1, linecolor=(0, 0, 1)
+    )
 
 view.add(surface.to_mesh(), show_lines=False)
 

setup.py

@@ -14,8 +14,7 @@
 
 def read(*names, **kwargs):
     return io.open(
-        path.join(here, *names),
-        encoding=kwargs.get("encoding", "utf8")
+        path.join(here, *names), encoding=kwargs.get("encoding", "utf8")
     ).read()
 
 

tasks.py

@@ -31,14 +31,14 @@ def flush(self):
 
     def write(self, message):
         self.flush()
-        self.out.write(message + '\n')
+        self.out.write(message + "\n")
         self.out.flush()
 
     def info(self, message):
-        self.write('[INFO] %s' % message)
+        self.write("[INFO] %s" % message)
 
     def warn(self, message):
-        self.write('[WARN] %s' % message)
+        self.write("[WARN] %s" % message)
 
 
 log = Log()
@@ -48,64 +48,70 @@ def confirm(question):
     while True:
         response = input(question).lower().strip()
 
-        if not response or response in ('n', 'no'):
+        if not response or response in ("n", "no"):
             return False
 
-        if response in ('y', 'yes'):
+        if response in ("y", "yes"):
             return True
 
-        print('Focus, kid! It is either (y)es or (n)o', file=sys.stderr)
+        print("Focus, kid! It is either (y)es or (n)o", file=sys.stderr)
 
 
 @task(default=True)
 def help(ctx):
     """Lists available tasks and usage."""
-    ctx.run('invoke --list')
+    ctx.run("invoke --list")
     log.write('Use "invoke -h <taskname>" to get detailed help for a task.')
 
 
-@task(help={
-    'docs': 'True to clean up generated documentation, otherwise False',
-    'bytecode': 'True to clean up compiled python files, otherwise False.',
-    'builds': 'True to clean up build/packaging artifacts, otherwise False.'})
+@task(
+    help={
+        "docs": "True to clean up generated documentation, otherwise False",
+        "bytecode": "True to clean up compiled python files, otherwise False.",
+        "builds": "True to clean up build/packaging artifacts, otherwise False.",
+    }
+)
 def clean(ctx, docs=True, bytecode=True, builds=True):
     """Cleans the local copy from compiled artifacts."""
 
     with chdir(BASE_FOLDER):
         if builds:
-            ctx.run('python setup.py clean')
+            ctx.run("python setup.py clean")
 
         if bytecode:
             for root, dirs, files in os.walk(BASE_FOLDER):
                 for f in files:
-                    if f.endswith('.pyc'):
+                    if f.endswith(".pyc"):
                         os.remove(os.path.join(root, f))
-                if '.git' in dirs:
-                    dirs.remove('.git')
+                if ".git" in dirs:
+                    dirs.remove(".git")
 
         folders = []
 
         if docs:
-            folders.append('docs/api/generated')
+            folders.append("docs/api/generated")
 
-        folders.append('dist/')
+        folders.append("dist/")
 
         if bytecode:
-            for t in ('src', 'tests'):
-                folders.extend(glob.glob('{}/**/__pycache__'.format(t), recursive=True))
+            for t in ("src", "tests"):
+                folders.extend(glob.glob("{}/**/__pycache__".format(t), recursive=True))
 
         if builds:
-            folders.append('build/')
-            folders.append('src/compas_occ.egg-info/')
+            folders.append("build/")
+            folders.append("src/compas_occ.egg-info/")
 
         for folder in folders:
             rmtree(os.path.join(BASE_FOLDER, folder), ignore_errors=True)
 
 
-@task(help={
-      'rebuild': 'True to clean all previously built docs before starting, otherwise False.',
-      'doctest': 'True to run doctests, otherwise False.',
-      'check_links': 'True to check all web links in docs for validity, otherwise False.'})
+@task(
+    help={
+        "rebuild": "True to clean all previously built docs before starting, otherwise False.",
+        "doctest": "True to run doctests, otherwise False.",
+        "check_links": "True to check all web links in docs for validity, otherwise False.",
+    }
+)
 def docs(ctx, doctest=False, rebuild=False, check_links=False):
     """Builds package's HTML documentation."""
 
@@ -116,8 +122,8 @@ def docs(ctx, doctest=False, rebuild=False, check_links=False):
         if doctest:
             testdocs(ctx)
 
-        opts = '-E' if rebuild else ''
-        ctx.run('sphinx-build {} -b html docs dist/docs'.format(opts))
+        opts = "-E" if rebuild else ""
+        ctx.run("sphinx-build {} -b html docs dist/docs".format(opts))
 
         if check_links:
             linkcheck(ctx, rebuild=rebuild)
@@ -126,23 +132,23 @@ def docs(ctx, doctest=False, rebuild=False, check_links=False):
 @task()
 def lint(ctx):
     """Check the consistency of coding style."""
-    log.write('Running flake8 python linter...')
-    ctx.run('flake8 src')
+    log.write("Running flake8 python linter...")
+    ctx.run("flake8 src")
 
 
 @task()
 def testdocs(ctx):
     """Test the examples in the docstrings."""
-    log.write('Running doctest...')
-    ctx.run('pytest --doctest-modules')
+    log.write("Running doctest...")
+    ctx.run("pytest --doctest-modules")
 
 
 @task()
 def linkcheck(ctx, rebuild=False):
     """Check links in documentation."""
-    log.write('Running link check...')
-    opts = '-E' if rebuild else ''
-    ctx.run('sphinx-build {} -b linkcheck docs dist/docs'.format(opts))
+    log.write("Running link check...")
+    opts = "-E" if rebuild else ""
+    ctx.run("sphinx-build {} -b linkcheck docs dist/docs".format(opts))
 
 
 @task()
@@ -152,79 +158,102 @@ def check(ctx):
     with chdir(BASE_FOLDER):
         lint(ctx)
 
-        log.write('Checking MANIFEST.in...')
-        ctx.run('check-manifest')
+        log.write("Checking MANIFEST.in...")
+        ctx.run("check-manifest")
 
-        log.write('Checking metadata...')
-        ctx.run('python setup.py check --strict --metadata')
+        log.write("Checking metadata...")
+        ctx.run("python setup.py check --strict --metadata")
 
 
-@task(help={
-      'checks': 'True to run all checks before testing, otherwise False.'})
+@task(help={"checks": "True to run all checks before testing, otherwise False."})
 def test(ctx, checks=False, doctest=False):
     """Run all tests."""
     if checks:
         check(ctx)
 
     with chdir(BASE_FOLDER):
-        cmd = ['pytest']
+        cmd = ["pytest"]
         if doctest:
-            cmd.append('--doctest-modules')
+            cmd.append("--doctest-modules")
 
-        ctx.run(' '.join(cmd))
+        ctx.run(" ".join(cmd))
 
 
 @task
 def prepare_changelog(ctx):
     """Prepare changelog for next release."""
-    UNRELEASED_CHANGELOG_TEMPLATE = '## Unreleased\n\n### Added\n\n### Changed\n\n### Removed\n\n\n## '
+    UNRELEASED_CHANGELOG_TEMPLATE = (
+        "## Unreleased\n\n### Added\n\n### Changed\n\n### Removed\n\n\n## "
+    )
 
     with chdir(BASE_FOLDER):
         # Preparing changelog for next release
-        with open('CHANGELOG.md', 'r+') as changelog:
+        with open("CHANGELOG.md", "r+") as changelog:
             content = changelog.read()
             changelog.seek(0)
-            changelog.write(content.replace(
-                '## ', UNRELEASED_CHANGELOG_TEMPLATE, 1))
+            changelog.write(content.replace("## ", UNRELEASED_CHANGELOG_TEMPLATE, 1))
 
-        ctx.run('git add CHANGELOG.md && git commit -m "Prepare changelog for next release"')
+        ctx.run(
+            'git add CHANGELOG.md && git commit -m "Prepare changelog for next release"'
+        )
 
 
-@task(help={
-      'gh_io_folder': 'Folder where GH_IO.dll is located. Defaults to the Rhino 6.0 installation folder (platform-specific).',
-      'ironpython': 'Command for running the IronPython executable. Defaults to `ipy`.'})
+@task(
+    help={
+        "gh_io_folder": "Folder where GH_IO.dll is located. Defaults to the Rhino 6.0 installation folder (platform-specific).",
+        "ironpython": "Command for running the IronPython executable. Defaults to `ipy`.",
+    }
+)
 def build_ghuser_components(ctx, gh_io_folder=None, ironpython=None):
     """Build Grasshopper user objects from source"""
     with chdir(BASE_FOLDER):
-        with tempfile.TemporaryDirectory('actions.ghcomponentizer') as action_dir:
-            target_dir = source_dir = os.path.abspath('src/compas_ghpython/components')
-            ctx.run('git clone https://github.com/compas-dev/compas-actions.ghpython_components.git {}'.format(action_dir))
+        with tempfile.TemporaryDirectory("actions.ghcomponentizer") as action_dir:
+            target_dir = source_dir = os.path.abspath("src/compas_ghpython/components")
+            ctx.run(
+                "git clone https://github.com/compas-dev/compas-actions.ghpython_components.git {}".format(
+                    action_dir
+                )
+            )
 
             if not gh_io_folder:
                 import compas_ghpython
-                gh_io_folder = compas_ghpython.get_grasshopper_plugin_path('6.0')
+
+                gh_io_folder = compas_ghpython.get_grasshopper_plugin_path("6.0")
 
             if not ironpython:
-                ironpython = 'ipy'
+                ironpython = "ipy"
 
             gh_io_folder = os.path.abspath(gh_io_folder)
-            componentizer_script = os.path.join(action_dir, 'componentize.py')
-
-            ctx.run('{} {} {} {} --ghio "{}"'.format(ironpython, componentizer_script, source_dir, target_dir, gh_io_folder))
-
-
-@task(help={
-      'release_type': 'Type of release follows semver rules. Must be one of: major, minor, patch.'})
+            componentizer_script = os.path.join(action_dir, "componentize.py")
+
+            ctx.run(
+                '{} {} {} {} --ghio "{}"'.format(
+                    ironpython,
+                    componentizer_script,
+                    source_dir,
+                    target_dir,
+                    gh_io_folder,
+                )
+            )
+
+
+@task(
+    help={
+        "release_type": "Type of release follows semver rules. Must be one of: major, minor, patch."
+    }
+)
 def release(ctx, release_type):
     """Releases the project in one swift command!"""
-    if release_type not in ('patch', 'minor', 'major'):
-        raise Exit('The release type parameter is invalid.\nMust be one of: major, minor, patch.')
+    if release_type not in ("patch", "minor", "major"):
+        raise Exit(
+            "The release type parameter is invalid.\nMust be one of: major, minor, patch."
+        )
 
     # Run checks
-    ctx.run('invoke check test')
+    ctx.run("invoke check test")
 
     # Bump version and git tag it
-    ctx.run('bump2version %s --verbose' % release_type)
+    ctx.run("bump2version %s --verbose" % release_type)
 
     # Prepare the change log for the next release
     prepare_changelog(ctx)