Merge pull request #88 from compas-dev/linting

Enforce code linting

Author: gonzalocasas

.github/pull_request_template.md

@@ -7,11 +7,15 @@
 - [ ] Bug fix in a **backwards-compatible** manner.
 - [ ] New feature in a **backwards-compatible** manner.
 - [ ] Breaking change: bug fix or new feature that involve incompatible API changes.
+- [ ] Other (e.g. doc update, configuration, etc)
 
 ### Checklist
 
-1. [ ] Add the change to the `CHANGELOG.rst` file in the `Unreleased` section under the most fitting heading: `Added`, `Changed`, `Removed`.
-1. [ ] Run all tests on your computer (i.e. `invoke test`).
-1. [ ] If you add new functions/classes, check that:
-   1. [ ] Are available on a second-level import, e.g. `compas_fab.robots.Configuration`.
-   1. [ ] Add unit tests (especially important for algorithm implementations).
+_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+
+- [ ] I added a line to the `CHANGELOG.rst` file in the `Unreleased` section under the most fitting heading (e.g. `Added`, `Changed`, `Removed`).
+- [ ] I ran all tests on my computer and it's all green (i.e. `invoke test`).
+- [ ] I ran lint on my computer and there are no errors (i.e. `invoke lint`) .
+- [ ] I added new functions/classes and made them available on a second-level import, e.g. `compas_fab.robots.Configuration`.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] I have added necessary documentation (if appropriate)

.travis.yml

@@ -53,7 +53,8 @@ script:
   - python -c "from compas_fab.backends.vrep.remote_api import vrep"
   - python -c "import compas_fab.robots"
   - python -c "import compas_fab.utilities"
-  - pytest
+  - invoke lint
+  - invoke test --no-doctest
   - if [[ "$TRAVIS_GENERATE_DOCS" == "true" ]]; then
       invoke docs;
     fi

CONTRIBUTING.rst

@@ -29,9 +29,15 @@ We love pull requests from everyone! Here's a quick guide to improve the code:
 
     invoke test
 
-7. Add yourself to ``AUTHORS.rst``.
-8. Commit your changes and push your branch to GitHub.
-9. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.
+7. Check there are no linter errors:
+
+::
+
+    invoke lint
+
+8. Add yourself to ``AUTHORS.rst``.
+9. Commit your changes and push your branch to GitHub.
+10. Create a `pull request <https://help.github.com/articles/about-pull-requests/>`_ through the GitHub website.
 
 
 During development, use `pyinvoke <http://docs.pyinvoke.org/>`_ tasks on the
@@ -40,6 +46,7 @@ command prompt to ease recurring operations:
 * ``invoke clean``: Clean all generated artifacts.
 * ``invoke check``: Run various code and documentation style checks.
 * ``invoke docs``: Generate documentation.
+* ``invoke lint``: Run code linter for coding style checks.
 * ``invoke test``: Run all tests and checks in one swift command.
 * ``invoke``: Show available tasks.
 

setup.cfg

@@ -3,7 +3,15 @@ universal = 1
 
 [flake8]
 max-line-length = 180
-exclude = */migrations/*
+exclude =
+    .git,
+    __pycache__,
+    docs,
+    build,
+    temp,
+    dist,
+    src/compas_fab/backends/vrep/remote_api/*,
+    src/compas_fab/ghpython/path_planning.py
 
 [tool:pytest]
 testpaths = tests

src/compas_fab/__init__.py

@@ -25,7 +25,14 @@
 
 import os
 
-from .__version__ import __author__, __author_email__, __copyright__, __description__, __license__, __title__, __url__, __version__
+from .__version__ import __author__
+from .__version__ import __author_email__
+from .__version__ import __copyright__
+from .__version__ import __description__
+from .__version__ import __license__
+from .__version__ import __title__
+from .__version__ import __url__
+from .__version__ import __version__
 
 HERE = os.path.dirname(__file__)
 DATA = os.path.abspath(os.path.join(HERE, 'data'))

src/compas_fab/backends/__init__.py

@@ -50,11 +50,11 @@
 
 """
 
-from .exceptions import *
-from .tasks import *
-from .ros.client import *
-from .ros.exceptions import *
-from .ros.fileserver_loader import *
-from .vrep.client import *
+from .exceptions import *               # noqa: F401,F403
+from .tasks import *                    # noqa: F401,F403
+from .ros.client import *               # noqa: F401,F403
+from .ros.exceptions import *           # noqa: F401,F403
+from .ros.fileserver_loader import *    # noqa: F401,F403
+from .vrep.client import *              # noqa: F401,F403
 
 __all__ = [name for name in dir() if not name.startswith('_')]

src/compas_fab/backends/ros/__init__.py

@@ -19,10 +19,10 @@
 
 from __future__ import absolute_import
 
-from .client import *
-from .exceptions import *
-from .fileserver_loader import *
-from .direct_ur_action_client import *
-from .messages import *
+from .client import *                     # noqa: F401,F403
+from .exceptions import *                 # noqa: F401,F403
+from .fileserver_loader import *          # noqa: F401,F403
+from .direct_ur_action_client import *    # noqa: F401,F403
+from .messages import *                   # noqa: F401,F403
 
 __all__ = [name for name in dir() if not name.startswith('_')]

src/compas_fab/backends/ros/client.py

@@ -169,7 +169,6 @@ def load_robot(self, load_geometry=False, urdf_param_name='/robot_description',
 
         return Robot(model, semantics=semantics, client=self)
 
-
     def inverse_kinematics(self, frame, base_link, group,
                            joint_names, joint_positions, avoid_collisions=True,
                            constraints=None, attempts=8,

src/compas_fab/backends/ros/messages/__init__.py

@@ -1,14 +1,13 @@
 from __future__ import absolute_import
 
-from .actionlib_msgs import *
-from .control_msgs import *
-from .geometry_msgs import *
-from .moveit_msgs import *
-from .object_recognition_msgs import *
-from .octomap_msgs import *
-from .sensor_msgs import *
-from .shape_msgs import *
-from .std_msgs import *
-from .trajectory_msgs import *
-
-from .services import *
+from .actionlib_msgs import *           # noqa: F401,F403
+from .control_msgs import *             # noqa: F401,F403
+from .geometry_msgs import *            # noqa: F401,F403
+from .moveit_msgs import *              # noqa: F401,F403
+from .object_recognition_msgs import *  # noqa: F401,F403
+from .octomap_msgs import *             # noqa: F401,F403
+from .sensor_msgs import *              # noqa: F401,F403
+from .services import *                 # noqa: F401,F403
+from .shape_msgs import *               # noqa: F401,F403
+from .std_msgs import *                 # noqa: F401,F403
+from .trajectory_msgs import *          # noqa: F401,F403

src/compas_fab/backends/ros/messages/actionlib_msgs.py

@@ -4,19 +4,22 @@
 from .std_msgs import Header
 from .std_msgs import Time
 
+
 class GoalID(ROSmsg):
     """http://docs.ros.org/api/actionlib_msgs/html/msg/GoalID.html
     """
+
     def __init__(self, stamp=Time(), id=""):
         self.stamp = stamp
         self.id = id
-    
+
     @classmethod
     def from_msg(cls, msg):
         stamp = Time.from_msg(msg['stamp'])
         id = msg['id']
         return cls(stamp, id)
 
+
 class GoalStatus(ROSmsg):
     """http://docs.ros.org/api/actionlib_msgs/html/msg/GoalStatus.html
     """
@@ -36,7 +39,7 @@ def __init__(self, goal_id=GoalID(), status=0, text=''):
         self.goal_id = goal_id
         self.status = status
         self.text = text
-    
+
     @classmethod
     def from_msg(cls, msg):
         goal_id = GoalID.from_msg(msg['goal_id'])
@@ -52,18 +55,21 @@ def human_readable(self):
                 return k
         return ''
 
+
 class GoalStatusArray(ROSmsg):
     """http://docs.ros.org/api/actionlib_msgs/html/msg/GoalStatusArray.html
     """
+
     def __init__(self, header=Header(), status_list=[]):
         self.header = header
         self.status_list = status_list
 
+
 """
 rostopic info /follow_joint_trajectory/cancel
 Type: actionlib_msgs/GoalID
 
 rostopic info /follow_joint_trajectory/status
 Type: actionlib_msgs/GoalStatusArray
 
-"""
+"""