Updates based on flake8 and yapf.

Author: lossyrob

.travis.yml

@@ -11,10 +11,7 @@ install:
   - pip install -r requirements-dev.txt
 
 script:
-  - flake8 pystac
-  - flake8 tests
-  - yapf -dpr pystac
-  - yapf -dpr tests
+  - .travis/style_checks
   - mypy -m pystac
   - python -m unittest discover tests/
 

.travis/style_checks

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+set -e
+
+if [[ -n "${PYSTAC_DEBUG}" ]]; then
+    set -x
+fi
+
+SOURCE="${BASH_SOURCE[0]}"
+while [ -h "$SOURCE" ] ; do SOURCE="$(readlink "$SOURCE")"; done
+TRAVIS_DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
+SRC_DIR="$( cd -P "$( dirname "TRAVIS_DIR" )" && pwd )"
+
+function usage() {
+    echo -n \
+"Usage: $(basename "$0")
+Test that code is compliant with yapf (code formatter) and flake8.
+"
+}
+
+
+if [ "${1:-}" = "--help" ]; then
+    usage
+else
+    echo $SRC_DIR
+
+    echo "Checking that library code is consistent with flake8..."
+    flake8 "$SRC_DIR/pystac"
+
+    echo "Checking that test code is consistent with flake8..."
+    flake8 "$SRC_DIR/tests"
+
+    # Exit code of 1 if yapf has a non-empty diff
+    # (ie. scripts/format_code needs to be run)
+    echo "Checking that code is consistent with yapf..."
+    if !(yapf -dpr "$SRC_DIR/pystac" > /dev/null &&
+             yapf -dpr "$SRC_DIR/tests" > /dev/null); then
+        echo "Code has not been formatted by yapf."
+        exit 1
+    fi
+fi

README.md

@@ -59,9 +59,9 @@ Unit tests are in the `tests` folder. To run unit tests, use `unittest`:
 
 ### Code quality checks
 
-PySTAC uses [flake8](), [yapf](), and [mypy]() for code formatting and type checking.
+PySTAC uses [flake8](http://flake8.pycqa.org/en/latest/), [yapf](https://github.com/google/yapf), and [mypy](http://mypy-lang.org/) for code formatting and type checking.
 
-To run the style checks:
+To run the flake8 style checks:
 
 ```
 > flake8 pystac
@@ -75,6 +75,8 @@ To format code:
 > yapf -ipr tests
 ```
 
+You could also run the `.travis/style_checks` script to check flake8 and yapf.
+
 To run the mypy static checker:
 
 ```

pystac/__init__.py

@@ -6,18 +6,22 @@
 
 from pystac.version import (__version__, STAC_VERSION)
 
+
 class STACError(Exception):
     pass
 
+
 from pystac.io import STAC_IO
 from pystac.stac_object import STACObject
 from pystac.link import (Link, LinkType)
 from pystac.catalog import (Catalog, CatalogType)
-from pystac.collection import (Collection, Extent, SpatialExtent, TemporalExtent, Provider)
+from pystac.collection import (Collection, Extent, SpatialExtent,
+                               TemporalExtent, Provider)
 from pystac.item import (Item, Asset)
 from pystac.eo import *
 from pystac.label import *
 
+
 def stac_object_from_dict(d):
     """Determines how to deserialize a dictionary into a STAC object.
 
@@ -33,4 +37,5 @@ def stac_object_from_dict(d):
     else:
         return Catalog.from_dict(d)
 
+
 STAC_IO.stac_object_from_dict = stac_object_from_dict

pystac/catalog.py

@@ -42,7 +42,6 @@ class Catalog(STACObject):
 
     See: https://github.com/radiantearth/stac-spec/blob/v0.8.0/catalog/catalog-spec.md
     """
-
     """Default file name that will be given to this STAC item in a cononical format."""
     DEFAULT_FILE_NAME = "catalog.json"
 
@@ -63,8 +62,8 @@ def __repr__(self):
 
     def set_root(self, root, link_type=LinkType.ABSOLUTE):
         STACObject.set_root(self, root, link_type)
-        root._resolved_objects = ResolvedObjectCache.merge(root._resolved_objects,
-                                                           self._resolved_objects)
+        root._resolved_objects = ResolvedObjectCache.merge(
+            root._resolved_objects, self._resolved_objects)
 
     def add_child(self, child, title=None):
         child.set_root(self.get_root())
@@ -180,16 +179,16 @@ def make_all_asset_hrefs_absolute(self):
             for item in items:
                 item.make_asset_hrefs_absolute()
 
-    def normalize_and_save(self,
-                           root_href,
-                           catalog_type):
+    def normalize_and_save(self, root_href, catalog_type):
         self.normalize_hrefs(root_href)
         self.save(catalog_type)
 
     def normalize_hrefs(self, root_href):
         # Normalizing requires an absolute path
         if not is_absolute_href(root_href):
-            root_href = make_absolute_href(root_href, os.getcwd(), start_is_dir=True)
+            root_href = make_absolute_href(root_href,
+                                           os.getcwd(),
+                                           start_is_dir=True)
 
         # Fully resolve the STAC to avoid linking issues.
         # This particularly can happen with unresolved links that have
@@ -230,23 +229,27 @@ def save(self, catalog_type):
         else:
             self.make_all_links_relative()
 
-        include_self_link = catalog_type in [CatalogType.ABSOLUTE_PUBLISHED,
-                                             CatalogType.RELATIVE_PUBLISHED]
+        include_self_link = catalog_type in [
+            CatalogType.ABSOLUTE_PUBLISHED, CatalogType.RELATIVE_PUBLISHED
+        ]
 
         if catalog_type == CatalogType.RELATIVE_PUBLISHED:
             child_catalog_type = CatalogType.SELF_CONTAINED
         else:
             child_catalog_type = catalog_type
 
-        items_include_self_link = catalog_type in [CatalogType.ABSOLUTE_PUBLISHED]
+        items_include_self_link = catalog_type in [
+            CatalogType.ABSOLUTE_PUBLISHED
+        ]
 
         for child_link in self.get_child_links():
             if child_link.is_resolved():
                 child_link.target.save(catalog_type=child_catalog_type)
 
         for item_link in self.get_item_links():
             if item_link.is_resolved():
-                item_link.target.save_object(include_self_link=items_include_self_link)
+                item_link.target.save_object(
+                    include_self_link=items_include_self_link)
 
         self.save_object(include_self_link=include_self_link)
 
@@ -270,8 +273,9 @@ def map_items(self, item_mapper):
         """Creates a copy of a catalog, with each item passed through the item_mapper function.
 
         Args:
-           item_mapper:   A function that takes in an item, and returns either an item or list of items.
-              The item that is passed into the item_mapper is a copy, so the method can mutate it safetly.
+            item_mapper:   A function that takes in an item, and returns either
+                an item or list of items. The item that is passed into the item_mapper
+                is a copy, so the method can mutate it safetly.
         """
 
         new_cat = self.full_copy()
@@ -290,9 +294,9 @@ def process_catalog(catalog):
                     item_links.append(item_link)
                 else:
                     for i in mapped:
-                        l = item_link.clone()
-                        l.target = i
-                        item_links.append(l)
+                        new_link = item_link.clone()
+                        new_link.target = i
+                        item_links.append(new_link)
             catalog.clear_items()
             catalog.add_links(item_links)
 
@@ -304,9 +308,10 @@ def map_assets(self, asset_mapper):
         through the asset_mapper function.
 
         Args:
-           asset_mapper:   A function that takes in an key and an Asset, and returns
-             either an Asset, a (key, Asset), or a dictionary of Assets with unique keys.
-             The Asset that is passed into the item_mapper is a copy, so the method can mutate it safetly.
+            asset_mapper:   A function that takes in an key and an Asset, and returns
+               either an Asset, a (key, Asset), or a dictionary of Assets with unique keys.
+               The Asset that is passed into the item_mapper is a copy, so the method can
+               mutate it safetly.
         """
         def apply_asset_mapper(tup):
             k, v = tup
@@ -324,8 +329,10 @@ def apply_asset_mapper(tup):
                 return assets
 
         def item_mapper(item):
-            new_assets = [x for result in map(apply_asset_mapper, item.assets.items())
-                            for x in result]
+            new_assets = [
+                x for result in map(apply_asset_mapper, item.assets.items())
+                for x in result
+            ]
             item.assets = dict(new_assets)
             return item
 
@@ -337,9 +344,9 @@ def describe(self, indent=0, include_hrefs=False):
             s += ' {}'.format(self.get_self_href())
         print(s)
         for child in self.get_children():
-            child.describe(indent=indent+4, include_hrefs=include_hrefs)
+            child.describe(indent=indent + 4, include_hrefs=include_hrefs)
         for item in self.get_items():
-            s = '{}* {}'.format(' ' * (indent+2), item)
+            s = '{}* {}'.format(' ' * (indent + 2), item)
             if include_hrefs:
                 s += ' {}'.format(item.get_self_href())
             print(s)
@@ -350,9 +357,7 @@ def from_dict(d):
         description = d['description']
         title = d.get('title')
 
-        cat = Catalog(id=id,
-                      description=description,
-                      title=title)
+        cat = Catalog(id=id, description=description, title=title)
 
         for l in d['links']:
             if not l['rel'] == 'root':

pystac/collection.py

@@ -1,16 +1,15 @@
 import json
 from datetime import datetime
-from datetime import timezone
 import dateutil.parser
 from copy import (copy, deepcopy)
-import json
 
-from pystac import STACError, STAC_IO
+from pystac import STACError
 from pystac.catalog import Catalog
 from pystac.link import (Link, LinkType)
 from pystac.io import STAC_IO
 from pystac.utils import (make_absolute_href, is_absolute_href)
 
+
 class Collection(Catalog):
     DEFAULT_FILE_NAME = "collection.json"
 
@@ -70,8 +69,8 @@ def clone(self):
                            extent=self.extent.clone(),
                            title=self.title,
                            license=self.license,
-                           stac_extensions = self.stac_extensions,
-                           keywords = self.keywords,
+                           stac_extensions=self.stac_extensions,
+                           keywords=self.keywords,
                            version=self.version,
                            providers=self.providers,
                            properties=self.properties,
@@ -118,8 +117,8 @@ def from_dict(d):
                 # If a root link was included, we want to inheret
                 # whether it was relative or not.
                 if not is_absolute_href(l['href']):
-                    collection.get_single_link('root').link_type = LinkType.RELATIVE
-
+                    collection.get_single_link(
+                        'root').link_type = LinkType.RELATIVE
 
         return collection
 
@@ -147,8 +146,7 @@ def to_dict(self):
         return deepcopy(d)
 
     def clone(self):
-        return Extent(spatial=copy(self.spatial),
-                      temporal=copy(self.temporal))
+        return Extent(spatial=copy(self.spatial), temporal=copy(self.temporal))
 
     @staticmethod
     def from_dict(d):
@@ -161,7 +159,7 @@ def __init__(self, bboxes):
         self.bboxes = bboxes
 
     def to_dict(self):
-        d = { 'bbox' : self.bboxes }
+        d = {'bbox': self.bboxes}
         return deepcopy(d)
 
     def clone(self):
@@ -176,7 +174,8 @@ def from_coordinates(coordinates):
         def process_coords(l, xmin=None, ymin=None, xmax=None, ymax=None):
             for coord in l:
                 if type(coord[0]) is list:
-                    xmin, ymin, xmax, ymax = process_coords(coord, xmin, ymin, xmax, ymax)
+                    xmin, ymin, xmax, ymax = process_coords(
+                        coord, xmin, ymin, xmax, ymax)
                 else:
                     x, y = coord
                     if xmin is None or x < xmin:
@@ -210,10 +209,12 @@ def to_dict(self):
             end = None
 
             if i[0]:
-                start = '{}Z'.format(i[0].replace(microsecond=0, tzinfo=None).isoformat())
+                start = '{}Z'.format(i[0].replace(microsecond=0,
+                                                  tzinfo=None).isoformat())
 
             if i[1]:
-                end = '{}Z'.format(i[1].replace(microsecond=0, tzinfo=None).isoformat())
+                end = '{}Z'.format(i[1].replace(microsecond=0,
+                                                tzinfo=None).isoformat())
 
             encoded_intervals.append([start, end])
 
@@ -241,7 +242,8 @@ def from_dict(d):
 
     @staticmethod
     def from_now():
-        return TemporalExtent(intervals=[[datetime.utcnow().replace(microsecond=0), None]])
+        return TemporalExtent(
+            intervals=[[datetime.utcnow().replace(microsecond=0), None]])
 
 
 class Provider:
@@ -252,7 +254,7 @@ def __init__(self, name, description=None, roles=None, url=None):
         self.url = url
 
     def to_dict(self):
-        d = { 'name': self.name }
+        d = {'name': self.name}
         if self.description is not None:
             d['description'] = self.description
         if self.roles is not None: