Rename AbstractBlock to Block; Block to CoreBlock

This renaming makes the API package much clearer, since the highest level block
abstraction is unqualified, and specializations of it are given qualifiers.

salve/api/__init__.py

@@ -0,0 +1 @@
+from salve.api.block import Block, CompiledBlock

salve/api/block.py

@@ -4,6 +4,7 @@
 
 import abc
 
+from salve.util.enum import Enum
 from salve.util.six import with_metaclass
 
 
@@ -35,14 +36,18 @@ def execute(self):
         pass  # pragma: no cover
 
 
-class AbstractBlock(with_metaclass(abc.ABCMeta)):
+class Block(with_metaclass(abc.ABCMeta)):
     """
     A block is the basic unit of configuration.
     Typically, blocks describe files, SALVE manifests, patches, etc
     This is an ABC that defines the common characteristics of all
     blocks. Furthermore, it defines the methods that must be implemented
     on a block by its author.
     """
+    # these are the valid types of block, and therefore the valid
+    # block identifiers (case insensitive)
+    types = Enum('FILE', 'MANIFEST', 'DIRECTORY')
+
     @abc.abstractmethod
     def has(self, attribute_name):
         """

salve/block/__init__.py

@@ -3,11 +3,10 @@
 import abc
 import os
 
-from salve.api.block import AbstractBlock
+from salve.api import Block
 
-from salve.util.enum import Enum
 from salve.util.error import SALVEException
-import salve.util.locations as locations
+from salve.util import locations
 
 from salve.util.six import with_metaclass
 
@@ -30,24 +29,20 @@ def __init__(self, msg, file_context):
         SALVEException.__init__(self, msg, file_context=file_context)
 
 
-class Block(with_metaclass(abc.ABCMeta, AbstractBlock)):
+class CoreBlock(with_metaclass(abc.ABCMeta, Block)):
     """
     A block is the basic unit of configuration.
     Typically, blocks describe files, SALVE manifests, patches, etc
     This is an ABC that defines the common characteristics of all
-    blocks.
+    blocks in the SALVE Core.
     """
-    # these are the valid types of block, and therefore the valid
-    # block identifiers (case insensitive)
-    types = Enum('FILE', 'MANIFEST', 'DIRECTORY')
-
     def __init__(self, ty, file_context):
         """
-        Base Block constructor.
+        Base CoreBlock constructor.
 
         Args:
             @ty
-            An element of Block.types, the type of the block.
+            An element of CoreBlock.types, the type of the block.
 
             @file_context
             The FileContext of this Block. Used to pass globals and

salve/block/directory_block.py

@@ -5,15 +5,13 @@
 import salve
 
 from salve import action
-from salve.action import backup
-from salve.action import copy
-from salve.action import create
-from salve.action import modify
+from salve.action import backup, copy, create, modify
 
-from salve.block import Block, BlockException
+from salve.api import Block
+from salve.block import CoreBlock, BlockException
 
 
-class DirBlock(Block):
+class DirBlock(CoreBlock):
     """
     A directory block describes an action performed on a directory.
     This includes creation, deletion, and copying from source.
@@ -26,7 +24,7 @@ def __init__(self, file_context):
             @file_context
             The FileContext for this block.
         """
-        Block.__init__(self, Block.types.DIRECTORY, file_context)
+        CoreBlock.__init__(self, Block.types.DIRECTORY, file_context)
         for attr in ['target', 'source']:
             self.path_attrs.add(attr)
         for attr in ['target']:

salve/block/file_block.py

@@ -5,15 +5,13 @@
 import salve
 
 from salve import action
-from salve.action import backup
-from salve.action import copy
-from salve.action import create
-from salve.action import modify
+from salve.action import backup, copy, create, modify
 
-from salve.block import Block, BlockException
+from salve.api import Block
+from salve.block import CoreBlock, BlockException
 
 
-class FileBlock(Block):
+class FileBlock(CoreBlock):
     """
     A file block describes an action performed on a file.
     This includes creation, deletion, and string append.
@@ -26,7 +24,7 @@ def __init__(self, file_context):
             @file_context
             The FileContext for this block.
         """
-        Block.__init__(self, Block.types.FILE, file_context)
+        CoreBlock.__init__(self, Block.types.FILE, file_context)
         for attr in ['target', 'source']:
             self.path_attrs.add(attr)
         for attr in ['target']:

salve/block/identifier.py

@@ -5,15 +5,13 @@
 from salve.reader.tokenize import Token
 
 from salve.block import BlockException
-import salve.block.file_block
-import salve.block.manifest_block
-import salve.block.directory_block
+from salve.block import file_block, manifest_block, directory_block
 
 # maps valid identifiers to block constructors
 identifier_map = {
-    'file': salve.block.file_block.FileBlock,
-    'manifest': salve.block.manifest_block.ManifestBlock,
-    'directory': salve.block.directory_block.DirBlock
+    'file': file_block.FileBlock,
+    'manifest': manifest_block.ManifestBlock,
+    'directory': directory_block.DirBlock
 }
 
 

salve/block/manifest_block.py

@@ -6,10 +6,11 @@
 from salve import action
 
 from salve.util.context import ExecutionContext
-from salve.block import Block
+from salve.api import Block
+from salve.block import CoreBlock
 
 
-class ManifestBlock(Block):
+class ManifestBlock(CoreBlock):
     """
     A manifest block describes another manifest to be expanded and
     executed. It may also specify properties of that manifest's
@@ -31,7 +32,7 @@ def __init__(self, file_context, source=None):
         # transition to the parsing/block expansion phase, converting
         # files into blocks
         salve.exec_context.transition(ExecutionContext.phases.PARSING)
-        Block.__init__(self, Block.types.MANIFEST, file_context)
+        CoreBlock.__init__(self, Block.types.MANIFEST, file_context)
         self.sub_blocks = None
         if source:
             self.set('source', source)