Create autoblack.yml (#5)

* Create autoblack.yml

* autoblack fix

* Create pyproject.toml

* autoblack fix

* Update setup.cfg

Co-authored-by: AutoBlack <>

Author: vfdev-5

.github/workflows/autoblack.yml

@@ -0,0 +1,19 @@
+name: Format python code
+on: push
+jobs:
+  autoblack:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: autoblack
+      uses: lgeiger/black-action@v1.0.1
+      with:
+        args: "."
+    - name: Commit and push changes
+      uses: stefanzweifel/git-auto-commit-action@v2.0.0
+      with:
+        commit_author_email: ''
+        commit_author_name: AutoBlack
+        commit_message: autoblack fix
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/source/conf.py

@@ -19,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'ImageTilingUtils'
-copyright = '2019, vfdev-5'
-author = 'vfdev-5'
+project = "ImageTilingUtils"
+copyright = "2019, vfdev-5"
+author = "vfdev-5"
 
 # The short X.Y version
 version = tiling.__version__
@@ -39,26 +39,26 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 source_parsers = {
-    '.md': CommonMarkParser,
+    ".md": CommonMarkParser,
 }
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -73,23 +73,23 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- 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"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 html_theme_options = {
-    'collapse_navigation': False,
+    "collapse_navigation": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -111,7 +111,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'ImageTilingUtilsdoc'
+htmlhelp_basename = "ImageTilingUtilsdoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -120,15 +120,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -138,19 +135,15 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'ImageTilingUtils.tex', 'ImageTilingUtils Documentation',
-     'vfdev-5', 'manual'),
+    (master_doc, "ImageTilingUtils.tex", "ImageTilingUtils Documentation", "vfdev-5", "manual",),
 ]
 
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'imagetilingutils', 'ImageTilingUtils Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "imagetilingutils", "ImageTilingUtils Documentation", [author], 1)]
 
 
 # -- Options for Texinfo output ----------------------------------------------
@@ -159,9 +152,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'ImageTilingUtils', 'ImageTilingUtils Documentation',
-     author, 'ImageTilingUtils', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "ImageTilingUtils",
+        "ImageTilingUtils Documentation",
+        author,
+        "ImageTilingUtils",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # -- Extension configuration -------------------------------------------------

pyproject.toml

@@ -0,0 +1,22 @@
+[tool.black]
+line-length = 120
+target-version = ['py35', 'py36', 'py37', 'py38']
+include = '\.pyi?$'
+exclude = '''
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | buck-out
+    | build
+    | dist
+  )/
+  | foo.py           # also separately exclude a file named foo.py in
+                     # the root of the project
+)
+'''

setup.cfg

@@ -3,7 +3,7 @@ max-line-length = 120
 
 [flake8]
 max-line-length = 120
-ignore = F401,E402,F403
+ignore = F401,E402,F403,E231
 exclude = venv
 
 [bdist_wheel]

setup.py

@@ -5,8 +5,7 @@
 
 
 def read(*names):
-    with codecs_open(os.path.join(os.path.dirname(__file__), *names),
-                     encoding="utf-8") as fp:
+    with codecs_open(os.path.join(os.path.dirname(__file__), *names), encoding="utf-8") as fp:
         return fp.read()
 
 
@@ -19,28 +18,21 @@ def find_version(*file_paths):
 
 
 long_description = read("README.md")
-version = find_version('tiling', '__init__.py')
+version = find_version("tiling", "__init__.py")
 
 
 setup(
     name="tiling",
     version=version,
-    description=u"Minimalistic set of image reader agnostic tools to easily iterate over large images",
+    description="Minimalistic set of image reader agnostic tools to easily iterate over large images",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="vfdev-5",
     author_email="vfdev.5@gmail.com",
     url="https://github.com/vfdev-5/ImageTilingUtils",
-    packages=find_packages(exclude=['tests', 'examples']),
-    install_requires=[
-        'six',
-    ],
-    license='MIT',
+    packages=find_packages(exclude=["tests", "examples"]),
+    install_requires=["six",],
+    license="MIT",
     test_suite="tests",
-    extras_require={
-        'tests': [
-            'pytest',
-            'pytest-cov'
-        ]
-    }
+    extras_require={"tests": ["pytest", "pytest-cov"]},
 )

tests/test_const_size.py

@@ -1,22 +1,26 @@
-
 import unittest
 
 from tiling import ConstSizeTiles
 
 
 class TestConstSizeTiles(unittest.TestCase):
-
     def test_wrong_args(self):
 
-        assertRaisesRegex = self.assertRaisesRegex if hasattr(self, 'assertRaisesRegex') else self.assertRaisesRegexp
+        assertRaisesRegex = self.assertRaisesRegex if hasattr(self, "assertRaisesRegex") else self.assertRaisesRegexp
 
-        with assertRaisesRegex(ValueError, "Argument min_overlapping should be between 0 and min tile_extent"):
+        with assertRaisesRegex(
+            ValueError, "Argument min_overlapping should be between 0 and min tile_extent",
+        ):
             ConstSizeTiles((500, 500), (256, 256), min_overlapping=-1)
 
-        with assertRaisesRegex(ValueError, "Argument min_overlapping should be between 0 and min tile_extent"):
+        with assertRaisesRegex(
+            ValueError, "Argument min_overlapping should be between 0 and min tile_extent",
+        ):
             ConstSizeTiles((500, 500), (256, 256), min_overlapping=300)
 
-        with assertRaisesRegex(ValueError, "Argument min_overlapping should be between 0 and min tile_extent"):
+        with assertRaisesRegex(
+            ValueError, "Argument min_overlapping should be between 0 and min tile_extent",
+        ):
             ConstSizeTiles((500, 500), (256, 256), min_overlapping=256)
 
     def test_wrong_index(self):
@@ -54,15 +58,11 @@ def test_as_iterator(self):
             self.assertEqual(extent1, extent2)
 
     def test_all(self):
-
         def _test(im_size, ts, scale, min_overlapping):
 
-            debug_msg = "im_size={} ts={} scale={} min_overlapping={}\n" \
-                .format(im_size, ts, scale, min_overlapping)
+            debug_msg = "im_size={} ts={} scale={} min_overlapping={}\n".format(im_size, ts, scale, min_overlapping)
 
-            tiles = ConstSizeTiles((im_size, im_size), ts,
-                                   min_overlapping=min_overlapping,
-                                   scale=scale)
+            tiles = ConstSizeTiles((im_size, im_size), ts, min_overlapping=min_overlapping, scale=scale)
 
             debug_msg += "n={}\n".format(len(tiles))
             self.assertGreater(len(tiles), 0, debug_msg)
@@ -78,15 +78,15 @@ def _test(im_size, ts, scale, min_overlapping):
             for i in range(1, len(tiles)):
                 extent, _ = tiles[i]
                 prev_extent, _ = tiles[i - 1]
-                var_debug_msg = "i={} extent={}\n" \
-                    .format(i, extent)
-                var_debug_msg += "prev_extent={}\n" \
-                    .format(prev_extent)
+                var_debug_msg = "i={} extent={}\n".format(i, extent)
+                var_debug_msg += "prev_extent={}\n".format(prev_extent)
 
                 for j in [0, 1]:
-                    self.assertGreaterEqual(tiles.tile_size[j] / tiles.scale - tiles.min_overlapping,
-                                            extent[j] - prev_extent[j],
-                                            debug_msg + var_debug_msg)
+                    self.assertGreaterEqual(
+                        tiles.tile_size[j] / tiles.scale - tiles.min_overlapping,
+                        extent[j] - prev_extent[j],
+                        debug_msg + var_debug_msg,
+                    )
 
             # Check the last tile ends at the boundary
             extent, _ = tiles[-1]