Skip to content

Initial attempt at documentation #20

Merged
merged 8 commits into from May 24, 2012
View
2 .gitignore
@@ -13,6 +13,8 @@ sdist
develop-eggs
MANIFEST
.installed.cfg
+*.swp
+doc/_build/
pip-log.txt
View
8 atomac/AXClasses.py
@@ -238,6 +238,14 @@ def _sendKey(self, keychr, modFlags=0, globally=False):
global or app specific
Returns: None or raise ValueError exception
'''
+ escapedChrs = {
+ '\n': AXKeyCodeConstants.RETURN,
+ '\r': AXKeyCodeConstants.RETURN,
+ '\t': AXKeyCodeConstants.TAB,
+ }
+ if keychr in escapedChrs:
+ keychr = escapedChrs[keychr]
+
self._addKeyToQueue(keychr, modFlags, globally=globally)
self._postQueuedEvents()
View
130 doc/Makefile
@@ -0,0 +1,130 @@
+# 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/ATOMac.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ATOMac.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/ATOMac"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ATOMac"
+ @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."
View
39 doc/apireference.rst
@@ -0,0 +1,39 @@
+ATOMac API Reference
+==================================
+
+.. automodule:: atomac
+
+.. autoexception:: Error
+
+.. autoexception:: ErrorAPIDisabled
+
+.. autoexception:: ErrorCannotComplete
+
+.. autoexception:: ErrorInvalidUIElement
+
+.. autoclass:: NativeUIElement
+ :members:
+ :undoc-members:
+
+.. autoclass:: Clipboard
+ :members:
+ :undoc-members:
+
+.. autoclass:: Prefs
+ :members:
+ :undoc-members:
+
+.. autofunction:: getAppRefByBundleId
+
+.. autofunction:: getAppRefByLocalizedName
+
+.. autofunction:: getAppRefByPid
+
+.. autofunction:: launchAppByBundleId
+
+.. autofunction:: launchAppByBundlePath
+
+.. autofunction:: terminateAppByBundleId
+
+.. autofunction:: setSystemWideTimeout
+
View
238 doc/conf.py
@@ -0,0 +1,238 @@
+# -*- coding: utf-8 -*-
+#
+# ATOMac documentation build configuration file, created by
+# sphinx-quickstart on Wed Jun 1 18:08:59 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('.'))
+# This should locate the parent directory for atomac
+sys.path.insert(0, os.path.abspath('..'))
+
+# Get info about the _a11y extension first
+import distutils.command.build
+from distutils.dist import Distribution
+
+b = distutils.command.build.build(Distribution())
+b.initialize_options()
+b.finalize_options()
+
+# Add to sys.path the path to the library build directory
+# This will work only if the library has been built from commandline via
+# python setup.py build
+# TODO: Integrate building the _a11y module before building the docs
+sys.path.insert(0, os.path.join(os.path.abspath('..'), b.build_platlib))
+
+# -- 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.doctest',
+ 'sphinx.ext.viewcode',
+ ]
+
+# 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'ATOMac'
+copyright = u'2012, Jesse Mendonca, Ken Song, James Tatum, Andrew Wu'
+
+# 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.
+# Set the __version__ variable
+execfile('../atomac/version.py')
+version = __version__
+# The full version, including alpha/beta/rc tags.
+release = __version__
+
+# 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 = False
+
+# 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 = '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 = 'ATOMacdoc'
+
+
+# -- 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', 'ATOMac.tex', u'ATOMac Documentation',
+ u'Jesse Mendonca, Ken Song, James Tatum, Andrew Wu', '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', 'atomac', u'ATOMac Documentation',
+ [u'Jesse Mendonca, Ken Song, James Tatum, Andrew Wu'], 1)
+]
View
51 doc/gettingstarted.rst
@@ -0,0 +1,51 @@
+===============
+Getting Started
+===============
+
+------------------
+Basic Requirements
+------------------
+
+* *Host*
+
+ ATOMac requires an Intel-based system running OS X and Xcode installed.
+
+ Tested OS versions:
+
+ * 10.6
+ * 10.7
+
+ It may work on 10.5.
+ If you experience issues with ATOMac on a particular version of OS X,
+ please open a ticket in the issue tracker.
+
+* *System Preferences*
+
+ System-wide accessibility must be enabled.
+
+ To enable access for assistive devices,
+ check the checkbox:
+
+ | *System Preferences >*
+ | *Universal Access >*
+ | *Enable access for assistive devices.*
+
+ Failure to enable this will result in ErrorAPIDisabled exceptions or invalid references.
+
+ To facilitate programmatic control via keyboard shortcuts,
+ select the radio button for *All Controls* under
+
+ | *System Preferences >*
+ | *Keyboard >*
+ | *Keyboard Shortcuts >*
+ | *Full Keyboard Access*
+
+* *Installation*
+
+ Installation should be as simple as running the following command line,
+ which will download, build and install ATOMac::
+
+ $ sudo easy_install atomac
+
+ Alternatively, you can use `pip <http://pypi.python.org/pypi/pip>`_
+ for easier module management.
View
34 doc/index.rst
@@ -0,0 +1,34 @@
+.. ATOMac documentation master file, created by
+ sphinx-quickstart on Wed Jun 1 18:08:59 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to ATOMac's documentation!
+==================================
+
+=====================================
+ATOMac - Automated Testing on the Mac
+=====================================
+
+Welcome to ATOMac:
+the first Python library to enable programmatic control
+of GUI applications via the Mac OS X accessibility API.
+It is fast and easy to use to write tests
+or otherwise control your GUI application.
+
+.. Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ gettingstarted
+ usage
+ apireference
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
View
108 doc/usage.rst
@@ -0,0 +1,108 @@
+Usage
+=====
+
+
+Working with Applications
+-------------------------
+
+Once the atomac module is installed,
+we should be able to use it to launch an application::
+
+ >>> import atomac
+ >>> atomac.launchAppByBundleId('com.apple.Automator')
+
+This should launch Automator.
+Next, we can get a reference to the UI element
+for the application itself::
+
+ >>> automator = atomac.getAppRefByBundleId('com.apple.Automator')
+ >>> automator
+ <atomac.AXClasses.NativeUIElement AXApplication u'Automator'>
+
+Other means of obtaining references to a running application include::
+
+ >>> automator = atomac.getAppRefByLocalizedName('Automator')
+ >>> automator = atomac.getAppRefByPid(12345)
+
+Finally, to terminate a running application,
+we can use the method ``terminateAppByBundleId``::
+
+ >>> atomac.terminateAppByBundleId('com.apple.Automator')
+
+
+Finding Objects in the Hierarchy
+--------------------------------
+
+Assuming we have an atomac reference
+to the running Automator application,
+we can find objects in the accessibility hierarchy::
+
+ >>> window = automator.windows()[0]
+ >>> window.AXTitle
+ u'Untitled'
+ >>> sheet = window.sheets()[0]
+
+Note that we retrieved an accessibility attribute
+from the Window object - AXTitle.
+ATOMac supports reading and writing of most attributes.
+Using Xcode's included *Accessibility Inspector* utility can provide
+a quick way to find these attributes.
+
+There is a shortcut for getting the sheet object
+which bypasses accessing it through the Window object.
+ATOMac can search all objects in the hierarchy
+by appending 'R' to the end of the method call::
+
+ >>> sheet = automator.sheetsR()[0]
+
+There are search methods for most types of accessibility objects.
+Each search method, such as ``windows``,
+has a corresponding recursive search function, such as ``windowsR``.
+The recursive search finds items
+that aren't just direct children of the associated object,
+but children of its children.
+These search methods can be given terms to identify specific elements.
+Note that "*" and "?" can be used as wildcard match characters
+in all ATOMac search methods::
+
+ >>> close = sheet.buttons('Close*')[0]
+
+ATOMac has a method to search for UI elements
+that match any number of criteria.
+The criteria are accessibility attributes
+(as outlined in Accessibility Inspector)::
+
+ >>> close = sheet.findFirst(AXRole='AXButton', AXTitle='Close')
+
+``FindFirst`` and ``FindFirstR`` return
+the first item found to match the criteria or ``None``.
+``FindAll`` and ``FindAllR`` return a list of all items
+that match the criteria or an empty list.
+
+
+Attributes and Actions
+----------------------
+
+Objects are fairly versatile.
+You can get a list of supported attributes and actions on an object::
+
+ >>> close.getAttributes()
+ [u'AXRole', u'AXRoleDescription', u'AXHelp', u'AXEnabled', u'AXFocused',
+ u'AXParent', u'AXWindow', u'AXTopLevelUIElement', u'AXPosition', u'AXSize',
+ u'AXTitle']
+ >>> close.AXTitle
+ u'Close'
+ >>> close.getActions()
+ [u'Press']
+
+Performing an action is as natural as::
+
+ >>> close.Press()
+
+Note that in Accessibility Inspector the action name begins with "AX-".
+To distinguish actions more easily from attributes,
+atomac drops the initial "AX" for names of actions.
+As a result, "AXPress" in Accessibility Inspector simply becomes
+"Press" in atomac and can be invoked on the object as ``Press()``.
+Any appropriate action can be triggered this way.
+
Something went wrong with that request. Please try again.