Merge pull request #56 from numberoverzero/docs-13-reimagined

Closes #13

Makefile

@@ -4,6 +4,6 @@ cov:
 	scripts/individual_coverage.sh
 
 docs:
-	rm -rf docs/_build
+    rm -rf docs/_build
 	cd docs && $(MAKE) html
 	firefox docs/_build/html/index.html

bloop/condition.py

@@ -210,6 +210,7 @@ def render(self, renderer):
         nref = renderer.name_ref(self.column, path=self.path)
         vref = renderer.value_ref(self.column, self.value,
                                   dumped=self.dumped, path=self.path)
+        # TODO special handling for == and != when value dumps to None
         comparator = self.comparator_strings[self.comparator]
         return "({} {} {})".format(nref, comparator, vref)
 

bloop/engine.py

@@ -1,6 +1,3 @@
-import collections
-import collections.abc
-
 import declare
 
 from .client import Client
@@ -23,16 +20,6 @@
 }
 
 
-def set_of(objs):
-    """wrap single elements in a set"""
-    if isinstance(objs, str):  # pragma: no cover
-        return {objs}
-    elif isinstance(objs, collections.abc.Iterable):
-        return set(objs)
-    else:
-        return {objs}
-
-
 def value_of(column):
     """value_of({'S': 'Space Invaders'}) -> 'Space Invaders'"""
     return next(iter(column.values()))
@@ -118,7 +105,7 @@ def _update(self, obj, attrs, expected, context=None, **kwargs):
             value = load(column.typedef, value, context=context, **kwargs)
             setattr(obj, column.model_name, value)
 
-    def bind(self, *, base):
+    def bind(self, base):
         """Create tables for all models subclassing base"""
         # If not manually configured, use a default bloop.Client
         # with the default boto3.client("dynamodb")
@@ -160,8 +147,8 @@ def is_verified(model):
                 self.type_engine.register(column.typedef)
             self.type_engine.bind(context={"engine": self})
 
-    def delete(self, objs, *, condition=None, atomic=None):
-        objs = set_of(objs)
+    def delete(self, *objs, condition=None, atomic=None):
+        objs = set(objs)
         for obj in objs:
             if obj.Meta.abstract:
                 raise AbstractModelException(obj)
@@ -176,7 +163,7 @@ def delete(self, objs, *, condition=None, atomic=None):
             self.client.delete_item(item)
             clear(obj)
 
-    def load(self, objs, consistent=None):
+    def load(self, *objs, consistent=None):
         """Populate objects from dynamodb, optionally using consistent reads.
 
         If any objects are not found, raises NotModified with the attribute
@@ -203,7 +190,7 @@ class HashAndRange(bloop.new_base()):
         # For an in-depth breakdown of the loading algorithm,
         # see docs/dev/internal.rst::Loading
         consistent = config(self, "consistent", consistent)
-        objs = set_of(objs)
+        objs = set(objs)
         for obj in objs:
             if obj.Meta.abstract:
                 raise AbstractModelException(obj)
@@ -260,8 +247,8 @@ def query(self, obj, consistent=None):
             engine=self, mode="query", model=model, index=index, strict=self.config["strict"], select=select,
             consistent=config(self, "consistent", consistent))
 
-    def save(self, objs, *, condition=None, atomic=None):
-        objs = set_of(objs)
+    def save(self, *objs, condition=None, atomic=None):
+        objs = set(objs)
         for obj in objs:
             if obj.Meta.abstract:
                 raise AbstractModelException(obj)
@@ -287,5 +274,5 @@ def scan(self, obj, consistent=None):
         if model.Meta.abstract:
             raise AbstractModelException(model)
         return Filter(
-            engine=self, mode="query", model=model, index=index, strict=self.config["strict"], select=select,
+            engine=self, mode="scan", model=model, index=index, strict=self.config["strict"], select=select,
             consistent=config(self, "consistent", consistent))

bloop/filter.py

@@ -146,7 +146,7 @@ def validate_key_for(model, index, key):
 class Filter:
     def __init__(
             self, *, engine, mode, model, index, strict, select, select_attributes=None, prefetch=0,
-            consistent=False, forward=True, limit=0, key=None, filter=None):
+            consistent=False, forward=True, limit=None, key=None, filter=None):
         self.engine = engine
         self.mode = mode
         self.model = model
@@ -158,7 +158,7 @@ def __init__(
         self._prefetch = prefetch
         self._consistent = consistent
         self._forward = forward
-        self._limit = limit
+        self._limit = limit or 0
 
         self._key = key
         self._filter = filter
@@ -390,12 +390,12 @@ def __iter__(self):
         return self
 
     def __next__(self):
-        # Still have buffered elements available
+        # still have buffered elements available
         if len(self._buffer) > 0:
             return self._buffer.popleft()
 
         # Refill the buffer until we hit the limit, or Dynamo stops giving us continue tokens.
-        while (not self.exhausted) and (len(self._buffer) < self._prefetch):
+        while (not self.exhausted) and len(self._buffer) < self._prefetch:
             response = self._call(self._prepared_request)
             continuation_token = response.get("LastEvaluatedKey", None)
             self._prepared_request["ExclusiveStartKey"] = continuation_token

bloop/index.py

@@ -77,28 +77,18 @@ def _bind(self, model):
 
 
 class GlobalSecondaryIndex(Index):
-    def __init__(self, *,
-                 hash_key=None, range_key=None, read_units=1, write_units=1, name=None, projection=None,
-                 **kwargs):
-        if hash_key is None:
-            raise ValueError("Must specify a hash_key for a GlobalSecondaryIndex")
-        if projection is None:
-            raise INVALID_PROJECTION
+    def __init__(self, *, projection, hash_key, range_key=None, read_units=1, write_units=1, name=None, **kwargs):
         super().__init__(hash_key=hash_key, range_key=range_key, name=name, projection=projection, **kwargs)
         self.write_units = write_units
         self.read_units = read_units
 
 
 class LocalSecondaryIndex(Index):
     """ LSIs don't have individual read/write units """
-    def __init__(self, *, range_key=None, name=None, projection=None, **kwargs):
-        # Hash key MUST be the table hash, pop any other values
+    def __init__(self, *, projection, range_key, name=None, **kwargs):
+        # Hash key MUST be the table hash; do not specify
         if "hash_key" in kwargs:
             raise ValueError("Can't specify the hash_key of a LocalSecondaryIndex")
-        if range_key is None:
-            raise ValueError("Must specify a range_key for a LocalSecondaryIndex")
-        if projection is None:
-            raise INVALID_PROJECTION
         if ("write_units" in kwargs) or ("read_units" in kwargs):
             raise ValueError("A LocalSecondaryIndex does not have its own read/write units")
         super().__init__(range_key=range_key, name=name, projection=projection, **kwargs)

bloop/model.py

@@ -72,12 +72,16 @@ def setup_columns(meta):
                 raise ValueError("Model hash_key over-specified")
             meta.hash_key = column
             meta.keys.add(column)
-        elif column.range_key:
+        if column.range_key:
             if meta.range_key:
                 raise ValueError("Model range_key over-specified")
             meta.range_key = column
             meta.keys.add(column)
         column.model = meta.model
+    # Don't throw when they're both None (could be abstract)
+    # but absolutely throw when they're both the same Column instance.
+    if meta.hash_key and (meta.hash_key is meta.range_key):
+        raise ValueError("hash_key and range_key must be different columns")
 
 
 def setup_indexes(meta):

bloop/types.py

@@ -107,10 +107,9 @@ class Model(Base):
 
     """
     python_type = arrow.Arrow
-    default_timezone = "UTC"
 
-    def __init__(self, timezone=None):
-        self.timezone = timezone or DateTime.default_timezone
+    def __init__(self, timezone="utc"):
+        self.timezone = timezone
         super().__init__()
 
     def dynamo_load(self, value, *, context, **kwargs):

docs/_static/custom.css

@@ -1,3 +1,15 @@
 div.sphinxsidebar {
     width: 240px;
 }
+
+/*
+Changed in 1.4b1
+https://github.com/sphinx-doc/sphinx/pull/2301
+https://github.com/sphinx-doc/sphinx/commit/b55b690d0f808be1371d4424d758dbd446fb5b98
+*/
+div.body p, div.body dd, div.body li, div.body blockquote {
+    -moz-hyphens: manual;
+    -ms-hyphens: manual;
+    -webkit-hyphens: manual;
+    hyphens: manual;
+}

docs/conf.py

@@ -40,10 +40,16 @@
 html_theme = 'alabaster'
 
 html_theme_options = {
+    'github_button': 'true',
     'github_user': 'numberoverzero',
     'github_repo': 'bloop',
     'github_banner': True,
-    'travis_button': True,
+
+    'github_type': 'star',
+    'github_count': 'true',
+
+    'fixed_sidebar': True,
+
     'show_powered_by': False,
     'analytics_id': 'UA-65843067-1'
 }