Commits

briancurtin  committed e5c6e21

Initial documentation checkins

  • Participants
  • Parent commits bc75ccf

Comments (0)

Files changed (6)

File docs/FileSystemWatcher.rst

+:mod:`FileSystemWatcher` -- a file system watcher
+=================================================
+
+:Author: Brian Curtin <curtin@acm.org>
+:Date: |today|
+:Summary: A high-level wrapper of :class:`Watcher`, attempting to be an almost
+          exact copy of the .NET
+          `FileSystemWatcher <http://msdn.microsoft.com/en-us/library/system.io.filesystemwatcher.aspx>`__
+          API.
+
+
+.. class:: FileSystemWatcher(directory, filter="*.*")
+
+   Specify a `directory` and optionally a `filter` for which you want to
+   receive file system updates about.
+   
+   If the `directory` does not exist or does not refer to a directory, a
+   :exc:`ValueError` will be raised.
+   
+   The `filter` argument specifies a simple filter supporting wildcards via
+   the asterisk.
+   
+      * "\*.\*" will find all files with all extensions.
+      * "\*.txt" will find all files with "txt" extension, e.g., blarga.txt
+      * "foo_2011*.log" will find all foo logfiles from 2011, e.g.,
+        foo_2011-01-24.log
+
+   Creating a :class:`FileSystemWatcher` starts a daemon thread to consume
+   file system updates from the underlying :class:`Watcher` instance.
+
+
+   .. data:: Changed
+             Created
+             Deleted
+             Renamed
+
+      These are effectively lists of callbacks for events of their namesake.
+      
+      The implemtnation is actually an `OrderedDict` with overloaded `+=` and
+      `-=` operators in order to match the functionality of the same `event`
+      objects in the .NET implementation. Callback objects are stored as both
+      the key and the value, so they can be hooked up and detached using
+      the callable object itself.
+      
+         >>> fsw.Changed += on_changed # Add the on_changed callback.
+         >>> fsw.Created -= on_removed # Remove the on_removed callback.
+
+
+   .. data:: EnableRaisingEvents
+   
+      Setting this property to ``True`` enables the receiving of file system
+      updates through the appropriate callbacks. Setting this property to
+      ``False`` disables the receiving of any callbacks.
+
+
+   .. data:: IncludeSubdirectories
+   
+      Setting this property to ``True`` causes callbacks to received when
+      file system updates on directories below the configured :data:`Path`
+      occur.
+
+      The default value is ``False``.
+
+   
+   .. data:: NotifyFilter
+   
+      A binary OR'ed set of :class:`NotifyFilters`.
+
+      Example flags to catch changes in file or directory names::
+
+         >>> fsw.NotifyFilter = NotifyFilters.FileName | NotifyFilters.DirectoryName
+
+      Example flag to catch only changes in the last write time of files, such
+      as when they are modified::
+
+         >>> fsw.NotifyFilter = NotifyFilters.LastWrite
+
+
+   .. data:: Filter
+   
+      A simple filter supporting wildcards via the asterisk. See the
+      :class:`FileSystemWatcher` for a number of filter examples.
+
+   
+   .. data:: Path
+   
+      A directory to be watched. This will raise :exc:`ValueError` if set to
+      a non-directory.
+
+
+.. class:: NotifyFilters
+
+   See the documentation for
+   `System.IO.NotifyFilters <http://msdn.microsoft.com/en-us/library/system.io.notifyfilters.aspx>`__.
+
+   .. data:: FileName
+             DirectoryName
+             Attributes
+             Size
+             LastWrite
+             LastAccess
+             CreationTime
+             Security
+
+
+.. class:: WatcherChangeTypes
+
+   See the documentation for
+   `System.IO.WatcherChangeTypes <http://msdn.microsoft.com/en-us/library/system.io.watcherchangetypes.aspx>`__.
+
+   .. data:: Created
+             Deleted
+             Changed
+             Renamed
+
+
+.. class:: FileSystemEventArgs
+
+   See the documentation for
+   `System.IO.FileSystemEventArgs <http://msdn.microsoft.com/en-us/library/system.io.filesystemeventargs.aspx>`__.
+
+   .. data:: ChangeType
+   
+      One of the :class:`WatcherChangeTypes`.
+
+   .. data:: FullPath
+
+      The fully qualified path to the file or directory which the event
+      is about.
+
+   .. data:: Name
+
+      The name of the file or directory which the event is about. This is
+      the same as calling ``os.path.basename(event.FullPath)``.
+
+
+.. class:: RenamedEventArgs
+
+   See the documentation for
+   `System.IO.FileSystemEventArgs <http://msdn.microsoft.com/en-us/library/system.io.renamedeventargs.aspx>`__.
+
+   This class is the same as :class:`FileSystemEventArgs` plus the following.
+   
+   .. data:: OldFullPath
+
+      The fully qualified path to the file or directory which the event
+      is about, before the :data:`FileSystemWatcher.Renamed` event occurred.
+
+   .. data:: OldName
+
+      The name of the file or directory which the event is about, before the
+      :data:`FileSystemWatcher.Renamed` event occurred. This is the same as
+      calling ``os.path.basename(event.OldFullPath)``.
+   

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) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+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 "  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/watcher.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/watcher.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/watcher"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/watcher"
+	@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."
+
+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/conf.py

+# -*- coding: utf-8 -*-
+#
+# watcher documentation build configuration file, created by
+# sphinx-quickstart on Fri Jan 21 13:09:16 2011.
+#
+# 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
+
+# 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 = []
+
+# 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'watcher'
+copyright = u'2011, Brian Curtin'
+
+# 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 = ['_build']
+
+# 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 = []
+
+
+# -- 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 = 'nature'
+
+# 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 = 'watcherdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'watcher.tex', u'watcher Documentation',
+   u'Brian Curtin', '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
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# 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', 'watcher', u'watcher Documentation',
+     [u'Brian Curtin'], 1)
+]

File docs/index.rst

+.. watcher documentation master file, created by
+   sphinx-quickstart on Fri Jan 21 13:09:16 2011.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to watcher's documentation!
+===================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   watcher
+   FileSystemWatcher
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

File docs/make.bat

+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	: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.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  changes    to make an overview over 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
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\watcher.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\watcher.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+:end

File docs/watcher.rst

+:mod:`watcher` -- a file system watcher
+=======================================
+
+:Author: Brian Curtin <curtin@acm.org>
+:Date: |today|
+:Summary: C extension to obtain file system updates for Win32
+
+
+.. class:: Watcher(directory, callback, \*args, \**kwargs)
+
+   Create a :class:`Watcher` object given a `directory`, and a `callback`
+   callable object. Additionally, `args` and `kwargs` can be provided,
+   which will passed into the `callback`.
+   
+   Creation of a :class:`Watcher` will raise a :exc:`TypeError` if less
+   than the two required arguments are passed, if the `directory` is not
+   Unicode object, or if the `callback` parameter is not callable.
+   
+   If the `directory` cannot be opened, a :exc:`WindowsError` will be raised.
+   
+   The required `callback` signature varies based on the arguments and
+   keyword arguments you pass.
+   
+      For the possible values of the first argument, see :ref:`notify-actions`.
+   
+      The second value will be a relative file or directory path starting from
+      the `directory` the :class:`Watcher` was created with.
+   
+      No additional arguments::
+
+         >>> def cb(id, name):
+         ...     print(id, name)
+         ...
+         >>> w = watcher.Watcher(os.getcwd(), cb)
+
+      Additional arguments::
+   
+         >>> def cb1(id, name, msg):
+         ...     print(id, name, msg)
+         ...
+         >>> def cb2(*args):
+         ...     print(args)
+         ...
+         >>> w1 = watcher.Watcher(os.getcwd(), cb1, "hello world")
+         >>> w2 = watcher.Watcher(os.getcwd(), cb2, "hello world")
+
+      Additional arguments and keywords::
+   
+         >>> def cb(id, name, msg, **kwargs):
+         ...     print(id, name, msg, kwargs)
+         ...
+         >>> w = watcher.Watcher(os.getcwd(), cb, "hurf durf", blarga=True)
+
+
+   .. data:: flags
+   
+      A binary OR'ed set of notification filters, listed below in
+      :ref:`notify-filters`
+   
+      Example flags to catch changes in file or directory names::
+
+         >>> w.flags = watcher.FILE_NOTIFY_CHANGE_FILE_NAME | watcher.FILE_NOTIFY_CHANGE_DIR_NAME
+
+      Example flag to catch only changes in the last write time of files, such
+      as when they are modified::
+
+         >>> w.flags = watcher.FILE_NOTIFY_CHANGE_LAST_WRITE
+
+
+   .. data:: recursive
+   
+      Set to ``True`` to receive updates to directories under the configured
+      parent directory. ``False`` will restrict updates to only the directory
+      :class:`Watcher` was initialized for.
+
+   .. data:: running
+
+      Any time after :meth:`start` has been called and before :meth:`stop` has
+      been called, :data:`running` will be ``True`` to signify that a
+      :class:`Watcher` is accepting file system updates. Otherwise it will be
+      ``False``.
+
+         >>> w.start()
+         >>> w.running
+         True
+         >>> w.stop()
+         >>> w.running
+         False
+
+
+   .. method:: start()
+
+      Start watching for file system changes which match your :data:`flags`.
+      After calling this method, your callback function will begin to receive
+      any changes as they occur.
+      
+      This method returns ``False`` if the :class:`Watcher` was already
+      started, or ``None`` on success.
+
+      This starts a Win32 thread in the background and waits on another Win32
+      thread which uses
+      `I/O Completion Ports <http://msdn.microsoft.com/en-us/library/aa365198(v=vs.85).aspx>`__
+      and the
+      `ReadDirectoryChangesW API <http://msdn.microsoft.com/en-us/library/aa365465(v=vs.85).aspx>`__
+      to obtain modifications to the file system.
+      
+      If the I/O Completion Port is unable to be created, or the watch thread
+      is unable to be created, a :exc:`WindowsError` will be raised.
+      
+      .. note::
+         This low-level interface does not currently handle cases where
+         the background watch thread encounters a Python exception, such as
+         where the callback function cannot be called. The exception will be
+         raised on the thread where it occurs and :data:`running` will be
+         changed to ``False``.
+         
+         This situation can usually be prevented by validating that the
+         callback signature matches what the :class:`Watcher` was created as.
+         Additionally, ensure that the :data:`flags` setting is valid.
+
+
+   .. method:: stop()
+   
+      Stop watching for file system changes. Your callback function will
+      receive no further calls from this object.
+      
+      This method returns ``False`` if the :class:``Watcher`` was already
+      stopped, or ``None`` on success.
+      
+      If the I/O Completion Port or watch thread handle are unable to be
+      closed, a :exc:`WindowsError` will be raised.
+
+
+.. _notify-filters:
+
+Notify Filters
+--------------
+
+.. data:: FILE_NOTIFY_CHANGE_FILE_NAME
+          FILE_NOTIFY_CHANGE_DIR_NAME
+          FILE_NOTIFY_CHANGE_ATTRIBUTES
+          FILE_NOTIFY_CHANGE_SIZE
+          FILE_NOTIFY_CHANGE_LAST_WRITE
+          FILE_NOTIFY_CHANGE_LAST_ACCESS
+          FILE_NOTIFY_CHANGE_CREATION
+          FILE_NOTIFY_CHANGE_SECURITY
+   
+   These are the available options for :data:`Watcher.flags`, known as
+   "notify filters".
+
+
+.. _notify-actions:
+
+Notify Actions
+--------------
+
+.. data:: FILE_ACTION_ADDED
+          FILE_ACTION_REMOVED
+          FILE_ACTION_MODIFIED
+          FILE_ACTION_RENAMED_OLD_NAME
+          FILE_ACTION_RENAMED_NEW_NAME
+   
+   These are the possible actions your callback will be notified with.
+   One of these values will be specified as the first argument to your
+   callback.