Commits

Anonymous committed 5267b22

General tidying up and sphinx-based docs added

  • Participants
  • Parent commits 298c5dd

Comments (0)

Files changed (10)

 ^www/
 ^IMAGES_IMPORT/
 ^generator/data
-^fabfile.py$
+^fabfile.py$
+^docs/build

File docs/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-statemachine.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-statemachine.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/django-statemachine"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-statemachine"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

File docs/source/api/fields.rst

+statemachine.fields
+===================
+
+.. automodule:: statemachine.fields
+   :members:
+   :special-members:

File docs/source/api/fsm.rst

+statemachine.fsm
+================
+
+The fsm module is the guts of the statemachine application. Among
+other things this module contains the State class which represents an
+individual state, and the FSM class which ensures state changes are
+allowed and that entry and exit functions are run.
+
+.. automodule:: statemachine.fsm
+   :members:
+

File docs/source/api/models.rst

+statemachine.models
+===================
+
+.. automodule:: statemachine.models
+   :members:

File docs/source/conf.py

+# -*- coding: utf-8 -*-
+#
+# django-statemachine documentation build configuration file, created by
+# sphinx-quickstart on Tue Jan  3 20:32:16 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+from django.conf import settings
+settings.configure()
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('../../'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-statemachine'
+copyright = u'2012, Ian George'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+autodoc_member_order = 'groupwise'
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-statemachinedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'django-statemachine.tex', u'django-statemachine Documentation',
+   u'Ian George', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'django-statemachine', u'django-statemachine Documentation',
+     [u'Ian George'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'django-statemachine', u'django-statemachine Documentation',
+   u'Ian George', 'django-statemachine', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

File docs/source/index.rst

+.. django-statemachine documentation master file, created by
+   sphinx-quickstart on Tue Jan  3 20:32:16 2012.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to django-statemachine's documentation!
+=============================================== 
+
+Django-statemachine is a simple state machine app for Django, it is
+still in fairly early stages of development, but has been used
+successfully in several production projects and continues to be
+improved.
+
+This project grew from a project I was working on that required a
+full-featured and robust Finite State Machine as its core data
+structure. There are still some areas that could do with some
+refactoring to make neat but as it stands (at 0.1) the app should be
+stable in use and reasonably quick under average load.
+
+Features
+--------
+* Exit states can be set for every state, or every state can be permissible.
+* Functions triggered on entry and exit from individual states
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+   api/models
+   api/fsm
+   api/fields
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

File docs/source/usage.rst

+Usage
+=====
+
+TBC

File statemachine/fields.py

 DEFAULT_STATE = "start"
 
 class FSM_StateField(models.Field):
+    """
+    Django models.Field subclass used to store a representation of
+    state from fsm.FSM
+
+    The underlying database value is a char(50)
+
+    Usage::
+
+        class Foo(models.Model):
+            blah = FSM_StateField(fsmFSM_class)
+
+        foo = Foo.objects.create()
+        print foo.blah.state
+        foo.blah.change('new_state')
+        foo.save()
+    """
+
     __metaclass__ = models.SubfieldBase
     description = "Finite State Machine Field"
+
     def __init__(self, machine, default_choices_all=False, *args, **kwargs):
+        """
+        machine: instance of fsm.FSM
+        default_choices_all: 
+
+        * If True sets choices to the results of all_state_choices
+        * If False set choices to the results of exit_state_choices
+
+        This constructor stores a copy of the class definition in
+        __machine_class and instantiates it in self.machine (*setting
+        an initial state from the database if available*) when
+        returning a python object.
+        """
+
         self.__machine_class = machine
         self.default_choices_all = default_choices_all
         defaults = {'max_length': 50, 'default' : DEFAULT_STATE}
 
     def validate(self, value, model_instance):
         pass
-        #print value.state
 
     def get_prep_value(self, value):
         return value
         return name
 
     def all_state_choices(self):
+        """
+        Returns a choices list of all the available states, useful for the admin interface.
+        """
         return [(name, pretty_name(name)) for name, state in self.machine.states.items()]
 
     def exit_state_choices(self):
+        """
+        Returns a choices list of only the available exit states from the current state.
+        """
         state_choices = []
         if self.machine.state:
             state_choices.append((self.machine.state,self.machine.state))

File statemachine/fsm.py

 from copy import deepcopy
 from django.conf import settings
 from django.forms.forms import pretty_name
-"""
-Some Exceptions
-"""
-class FSM_Exception(Exception): pass
-class FSM_TransitionNotAllowed(FSM_Exception): pass
-class FSM_StateDoesNotExist(FSM_Exception): pass
+from django.utils.datastructures import SortedDict
+
+# Django settings
+try:
+    STATE_MACHINE_KEEP_HISTORY = settings.STATE_MACHINE_KEEP_HISTORY
+except AttributeError:
+    STATE_MACHINE_KEEP_HISTORY = True
+try:
+    STATE_MACHINE_DEFAULT = settings.STATE_MACHINE_DEFAULT
+except AttributeError:
+    STATE_MACHINE_DEFAULT = "start"
+
+#Some Exceptions
+class FSM_Exception(Exception): 
+    """ 
+    Base exception for the FSM implementation.
+    """
+    pass
+class FSM_TransitionNotAllowed(FSM_Exception): 
+    """
+    Raised when a state change is prevented, generally when an the attempted change isn't in the exit_states list.
+    """
+    pass
+class FSM_StateDoesNotExist(FSM_Exception):
+    """
+    Raised when a change to a non-existent state is requested.
+    """
 class FSM_NotAllowed(FSM_Exception): pass
 
 class FSM_VerificationError(FSM_Exception):
+    """
+    Verification error, raised when FSM.verify() fails, should contain a list of failed states.
+    """
     def __init__(self, message, states=None):
         self.message = message
         self.states = states
         else:
             return self.message
 
-"""
-Django settings
-"""
-try:
-    STATE_MACHINE_KEEP_HISTORY = settings.STATE_MACHINE_KEEP_HISTORY
-except AttributeError:
-    STATE_MACHINE_KEEP_HISTORY = True
-try:
-    STATE_MACHINE_DEFAULT = settings.STATE_MACHINE_DEFAULT
-except AttributeError:
-    STATE_MACHINE_DEFAULT = "start"
-
-
-from django.utils.datastructures import SortedDict
-
 def get_declared_states(bases, attrs, with_base_states=True):
     """
-    ** "Inspired by" django.forms.forms **
+    *Taken pretty much verbatim from django.forms*
 
     Create a list of State instances from the passed in 'attrs', plus any
     similar states on the base classes (in 'bases').
     If 'with_base_states' is True, all states from the bases are used.
     Otherwise, only states in the 'declared_states' attribute on the bases are
     used.
+
     """
     states = [(state_name, attrs.pop(state_name)) for state_name, obj in attrs.items() if isinstance(obj, State)]
     for name, state in states:
 
 class DeclarativeStatesMetaclass(type):
     """
+    *Taken pretty much verbatim from django.forms*
+
     Metaclass that converts State attributes to a dictionary called
     'base_states', taking into account parent class 'base_states' as well.
+
     """
     def __new__(cls, name, bases, attrs):
         attrs['base_states'] = get_declared_states(bases, attrs)
         
 class FSM(object):
     """
-    Simple FSM implementation.
+    Simple FSM implementation. Takes a declarative approach to
+    defining states, and their interactions and capabilities.
+
+    
     """
     __metaclass__ = DeclarativeStatesMetaclass
 
     state = property(getstate, setstate)
 
     def set_initial_state(self, state):
+        """
+        Sets the initial state of the FSM, should only be used when
+        restoring a FSM into a state that has been previously attained
+        from the inital state.
+        """
         self.__state = state
 
     def available_states(self):
+        """
+        Returns a list containing the available exit states from the current state
+        """
         return [self.states[s] for s in self.states[self.__state].exit_states]
         
     def verify(self):
         """
-        Check that all the named exit states exist, list the ones that don't
+        Check that all the states named in exit_states exist.
+
+        If any named states are missing verify() throws a
+        FSM_VerificationError which contains a list of the bad states.
         """
         bad_states = []
         state_names = set(self.states.keys())
 
     def change(self, new_state, *args, **kwargs):
         """
-        Transitions the machine to its new state.
+        Transitions the machine to its new state, assuming it is a
+        valid exit state and that entry and exit functions allow it.
+
+        All provided arguments are passed to the relevant exit and entry
+        functions as well as the current state.
         """
         if self.verify_on_execute:
             self.verify()