Commit 0d3e60f2 authored by Jelte Jansen's avatar Jelte Jansen
Browse files

added some module-level docstrings


git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@1443 e5f2f494-b856-4b98-b285-d166d9295462
parent 8094e981
......@@ -13,6 +13,11 @@
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""This module holds the BindCmdInterpreter class. This provides the
core functionality for bindctl. It maintains a session with
b10-cmdctl, holds local configuration and module information, and
handles command line interface commands"""
import sys
from cmd import Cmd
from bindctl.exception import *
......
......@@ -15,6 +15,8 @@
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""This is the main calling class for the bindctl configuration and
command tool. It sets up a command interpreter and runs that."""
import sys; sys.path.append ('@@PYTHONPATH@@')
......@@ -26,6 +28,7 @@ from optparse import OptionParser, OptionValueError
__version__ = 'Bindctl'
def prepare_config_commands(tool):
'''Prepare fixed commands for local configuration editing'''
module = ModuleInfo(name = "config", desc = "Configuration commands")
cmd = CommandInfo(name = "show", desc = "Show configuration")
param = ParamInfo(name = "identifier", type = "string", optional=True)
......
......@@ -13,6 +13,9 @@
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""This module holds the command parser class for bindctl"""
import re
from bindctl.exception import *
try:
......
......@@ -13,7 +13,7 @@
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""This module holds exception classes specific for bindctl"""
class BindCtlException(Exception):
"""Abstract base class shared by all bindctl exceptions"""
def __str__(self):
......
......@@ -13,6 +13,8 @@
# NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
# WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
"""This module holds classes representing modules, commands and
parameters for use in bindctl"""
try:
from collections import OrderedDict
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment