pep8 mypy

Author: scivision

.appveyor.yml

@@ -1,6 +1,5 @@
 image:
 - Visual Studio 2017
-- Ubuntu
 
 stack: python 3
 

.coveragerc

@@ -0,0 +1,12 @@
+[run]
+omit =
+    /home/travis/virtualenv/*
+    
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    raise NotImplementedError
+    raise ImportError
+    raise ValueError
+    raise TypeError

.travis.yml

@@ -2,7 +2,7 @@ language: python
 fast_finish: true
 
 python: 
-  - 2.7
+  - 3.5
   - 3.6
   - "3.7-dev"
 
@@ -43,7 +43,9 @@ install:
   - cd ..
 
 script: 
-  - pytest -v
+  - pytest -sv
+  - flake8
+  - mypy . --ignore-missing-imports
 
 after_success: 
   - if [[ $TRAVIS_PYTHON_VERSION == 3.6* ]]; then

DemoLineclip.py

@@ -6,16 +6,17 @@
 make box with corners LL/UR (1,3) (4,5)
 and line segment with ends (0,0) (4,6)
 """
-#%% LOWER to UPPER test
+# %% LOWER to UPPER test
 x1, y1, x2, y2 = cohensutherland(1,  5, 4, 3,
                                  0,  0, 4, 6)
 
-np.testing.assert_array_almost_equal([x1,y1,x2,y2],[2, 3, 3.3333333333333,5])
-#%% no intersection test
-x1,y1,x2,y2 = cohensutherland(1,5,  4,3,
-                              0,0.1,0,0.1)
-assert x1==y1==x2==y2==None
-#%% left to right test
-x1,y1,x2,y2 = cohensutherland(1,5,4,3,
-                              0,4,5,4)
-np.testing.assert_array_almost_equal([x1,y1,x2,y2],[1, 4, 4, 4])
+np.testing.assert_array_almost_equal([x1, y1, x2, y2], [2, 3, 3.3333333333333, 5])
+# %% no intersection test
+x1, y1, x2, y2 = cohensutherland(1, 5,  4, 3,
+                                 0, 0.1, 0, 0.1)
+
+assert x1 is None and y1 is None and x2 is None and y2 is None
+# %% left to right test
+x1, y1, x2, y2 = cohensutherland(1, 5, 4, 3,
+                                 0, 4, 5, 4)
+np.testing.assert_array_almost_equal([x1, y1, x2, y2], [1, 4, 4, 4])

README.md

@@ -0,0 +1,77 @@
+[![Travis CI](https://travis-ci.org/scivision/lineclipping-python-fortran.svg?branch=master)](https://travis-ci.org/scivision/lineclipping-python-fortran)
+[![AppVeyor](https://ci.appveyor.com/api/projects/status/cr0omkhjvgwcyxiy?svg=true)](https://ci.appveyor.com/project/scivision/lineclipping-python-fortran)
+
+# Line clipping
+
+-   lineClipping.jl Cohen-Sutherland line clipping algorithm for Julia.
+    Input scalars, output intersection length, or `None` if no intersection.
+-   lineclipping.f90 Cohen-Sutherland line clipping algorithm for
+    massively parallel coarray modern Fortran. Input scalars or arrays,
+    output intersections or `NaN` if no intersection.
+-   lineClipping.py Cohen-Sutherland line clipping algorithm for Python.
+    Input scalars, output intersection length, or `None` if no intersection.
+
+## Install
+
+### Python
+
+    python -m pip install -e .
+
+### Fortran
+
+If you want to use the Fortran Cohen-Sutherland line clipping modules
+directly (optional):
+
+    cd bin
+    cmake ..
+    make
+
+## Usage
+
+The main difference with textbook implementations is that I return a
+sentinel value (NaN, None, nothing) if there's no intersection of line
+with box.
+
+### Python
+
+```python
+import pylineclip.lineclipping as lc
+
+x3,y3,x4,y4 = lc.cohensutherland((xmin, ymax, xmax, ymin, x1, y1, x2, y2)
+```
+
+If no intersection, `(None, None, None, None)` is returned.
+
+### Fortran
+
+lineclipping.f90 has two subroutines. 
+Pick Ccohensutherland if you're calling from C/C++/Python, which cannot tolerate assummed-shape arrays.
+It's a slim wrapper to cohensutherland which is elemental (can handle scalar or any rank array).
+
+Fortran programs will simply use
+
+```fortran
+use lineclipping
+call cohensutherland(xmin,ymax,xmax,ymin,x1,y1,x2,y2)
+```
+
+The arguments are:
+
+    INPUTS
+    ------
+    xmin,ymax,xmax,ymin:  upper left and lower right corners of box (pixel coordinates)
+
+    INOUT
+    -----
+    x1,y1,x2,y2: 
+    in - endpoints of line
+    out - intersection points with box. If no intersection, all NaN
+
+### Julia
+
+Simliar to Python, except `nothing` is returned if no intersection
+found.
+
+```julia
+cohensutherland(xmin, ymax, xmax, ymin, x1, y1, x2, y2)
+```

README.rst

@@ -1,15 +1,20 @@
 #!/usr/bin/env python
-from __future__ import division
-#from numba import jit
+from typing import Union, Tuple
+# from numba import jit
 '''
  The MIT License (MIT)
  Copyright (c) 2014 Michael Hirsch
  reference: http://en.wikipedia.org/wiki/Cohen%E2%80%93Sutherland_algorithm
- * The best way to Numba JIT this would probably be in the function calling this, 
+ * The best way to Numba JIT this would probably be in the function calling this,
    to include the loop itself inside the jit decoration.
 '''
-#@jit
-def cohensutherland(xmin, ymax, xmax, ymin, x1, y1, x2, y2):
+
+# @jit
+
+
+def cohensutherland(xmin: float, ymax: float, xmax: float, ymin: float,
+                    x1: float, y1: float, x2: float, y2: float) -> Tuple[
+                    Union[None, float], Union[None, float], Union[None, float], Union[None, float]]:
     """Clips a line to a rectangular area.
 
     This implements the Cohen-Sutherland line clipping algorithm.  xmin,
@@ -21,11 +26,11 @@ def cohensutherland(xmin, ymax, xmax, ymin, x1, y1, x2, y2):
     four None values will be returned as tuple. Otherwise a tuple of the
     clipped line points will be returned in the form (cx1, cy1, cx2, cy2).
     """
-    INSIDE,LEFT, RIGHT, LOWER, UPPER = 0,1, 2, 4, 8
+    INSIDE, LEFT, RIGHT, LOWER, UPPER = 0, 1, 2, 4, 8
 
     def _getclip(xa, ya):
-        #if dbglvl>1: print('point: '),; print(xa,ya)
-        p = INSIDE  #default is inside
+        # if dbglvl>1: print('point: '),; print(xa,ya)
+        p = INSIDE  # default is inside
 
         # consider x
         if xa < xmin:
@@ -35,29 +40,29 @@ def _getclip(xa, ya):
 
         # consider y
         if ya < ymin:
-            p |= LOWER # bitwise OR
+            p |= LOWER  # bitwise OR
         elif ya > ymax:
-            p |= UPPER #bitwise OR
+            p |= UPPER  # bitwise OR
         return p
 
 # check for trivially outside lines
     k1 = _getclip(x1, y1)
     k2 = _getclip(x2, y2)
 
-#%% examine non-trivially outside points
-    #bitwise OR |
-    while (k1 | k2) != 0: # if both points are inside box (0000) , ACCEPT trivial whole line in box
+# %% examine non-trivially outside points
+    # bitwise OR |
+    while (k1 | k2) != 0:  # if both points are inside box (0000) , ACCEPT trivial whole line in box
 
         # if line trivially outside window, REJECT
-        if (k1 & k2) != 0: #bitwise AND &
-            #if dbglvl>1: print('  REJECT trivially outside box')
-            #return nan, nan, nan, nan
+        if (k1 & k2) != 0:  # bitwise AND &
+            # if dbglvl>1: print('  REJECT trivially outside box')
+            # return nan, nan, nan, nan
             return None, None, None, None
 
-        #non-trivial case, at least one point outside window
+        # non-trivial case, at least one point outside window
         # this is not a bitwise or, it's the word "or"
-        opt = k1 or k2 # take first non-zero point, short circuit logic
-        if opt & UPPER: #these are bitwise ANDS
+        opt = k1 or k2  # take first non-zero point, short circuit logic
+        if opt & UPPER:  # these are bitwise ANDS
             x = x1 + (x2 - x1) * (ymax - y1) / (y2 - y1)
             y = ymax
         elif opt & LOWER:
@@ -75,11 +80,10 @@ def _getclip(xa, ya):
         if opt == k1:
             x1, y1 = x, y
             k1 = _getclip(x1, y1)
-            #if dbglvl>1: print('checking k1: ' + str(x) + ',' + str(y) + '    ' + str(k1))
+            # if dbglvl>1: print('checking k1: ' + str(x) + ',' + str(y) + '    ' + str(k1))
         elif opt == k2:
-            #if dbglvl>1: print('checking k2: ' + str(x) + ',' + str(y) + '    ' + str(k2))
+            # if dbglvl>1: print('checking k2: ' + str(x) + ',' + str(y) + '    ' + str(k2))
             x2, y2 = x, y
             k2 = _getclip(x2, y2)
-            
-    return x1, y1, x2, y2
 
+    return x1, y1, x2, y2

pylineclip/__init__.py

@@ -0,0 +1,6 @@
+[metadata]
+description-file = README.md
+
+[flake8]
+max-line-length = 132
+exclude = .git,__pycache__,docs/,build/,dist/,archive/

setup.cfg

@@ -1,34 +1,33 @@
 #!/usr/bin/env python
+from setuptools import setup, find_packages
+
 install_requires = ['numpy']
-tests_require=['pytest','nose','coveralls']
-# %%
-from setuptools import setup,find_packages
+tests_require = ['pytest', 'coveralls', 'flake8', 'mypy']
+
 
 setup(name='pylineclip',
       packages=find_packages(),
       description='Line clipping: Cohen-Sutherland',
-      long_description=open('README.rst').read(),
+      long_description=open('README.md').read(),
+      long_description_content_type="text/markdown",
       version='0.9.0',
       author='Michael Hirsch, Ph.D.',
       url='https://github.com/scivision/lineclipping-python-fortran',
       classifiers=[
-      'Development Status :: 4 - Beta',
-      'Environment :: Console',
-      'Intended Audience :: Science/Research',
-      'License :: OSI Approved :: MIT License',
-      'Operating System :: OS Independent',
-      'Programming Language :: Python :: 2.7',
-      'Programming Language :: Python :: 3.4',
-      'Programming Language :: Python :: 3.5',
-      'Programming Language :: Python :: 3.6',
-      'Programming Language :: Python :: 3.7',
-      'Topic :: Scientific/Engineering :: Visualization',
+          'Development Status :: 4 - Beta',
+          'Environment :: Console',
+          'Intended Audience :: Science/Research',
+          'License :: OSI Approved :: MIT License',
+          'Operating System :: OS Independent',
+          'Programming Language :: Python :: 3.5',
+          'Programming Language :: Python :: 3.6',
+          'Programming Language :: Python :: 3.7',
+          'Topic :: Scientific/Engineering :: Visualization',
       ],
       install_requires=install_requires,
       tests_require=tests_require,
-      extras_require={'tests':tests_require},
-      python_requires='>=2.7',
+      extras_require={'tests': tests_require},
+      python_requires='>=3.5',
       scripts=['DemoLineclip.py'],
       include_package_data=True,
-	  )
-
+      )