├── .gitignore
├── I-Sheet-You-Not-0.3.2.alfredworkflow
├── LICENCE.txt
├── README.md
├── bin
    ├── build-docs.sh
    └── publish-docs.sh
├── demo.gif
├── doc
    ├── Makefile
    ├── _static
    │   ├── config_sheet.png
    │   ├── custom.css
    │   ├── demo.gif
    │   ├── favicon.ico
    │   └── icon_256.png
    ├── _templates
    │   ├── donate.html
    │   └── page.html
    ├── _themes
    │   └── alabaster
    │   │   ├── __init__.py
    │   │   ├── _version.py
    │   │   ├── about.html
    │   │   ├── donate.html
    │   │   ├── layout.html
    │   │   ├── navigation.html
    │   │   ├── relations.html
    │   │   ├── static
    │   │       ├── alabaster.css_t
    │   │       └── custom.css
    │   │   ├── support.py
    │   │   └── theme.conf
    ├── api.rst
    ├── changelog.rst
    ├── conf.py
    ├── index.rst
    └── licence.rst
├── icon.png
├── modd.conf
└── src
    ├── Demo.xlsx
    ├── LICENCE.txt
    ├── buildme
    ├── icon.png
    ├── info.plist
    ├── isheetyounot
        ├── __init__.py
        ├── __main__.py
        ├── aw3.py
        ├── cli.py
        └── core.py
    ├── isyn
    └── xlrd
        ├── __init__.py
        ├── biffh.py
        ├── book.py
        ├── compdoc.py
        ├── doc
            ├── compdoc.html
            └── xlrd.html
        ├── examples
            ├── namesdemo.xls
            └── xlrdnameAPIdemo.py
        ├── formatting.py
        ├── formula.py
        ├── info.py
        ├── licences.py
        ├── sheet.py
        ├── timemachine.py
        ├── xldate.py
        └── xlsx.py


/.gitignore:
--------------------------------------------------------------------------------
  1 | #                         d88b
  2 | #                         8`'8
  3 | # .d8888b. .d8888b.       d8b        .d8888b. 88d888b. 88d888b. .d8888b.
  4 | # 88'  `88 Y8ooooo.     d8P`8b       88'  `88 88'  `88 88'  `88 Y8ooooo.
  5 | # 88.  .88       88     d8' `8bP     88.  .88 88.  .88 88.  .88       88
  6 | # `88888P' `88888P'     `888P'`YP    `88888P8 88Y888P' 88Y888P' `88888P'
  7 | #                                             88       88
  8 | #                                             dP       dP                                                             dP       dP
  9 | .DS_Store
 10 | ._*
 11 | Icon
 12 | 
 13 | 
 14 | # Dropbox
 15 | .dropbox.attr
 16 | 
 17 | #                dP oo   dP
 18 | #                88      88
 19 | # .d8888b. .d888b88 dP d8888P .d8888b. 88d888b. .d8888b.
 20 | # 88ooood8 88'  `88 88   88   88'  `88 88'  `88 Y8ooooo.
 21 | # 88.  ... 88.  .88 88   88   88.  .88 88             88
 22 | # `88888P' `88888P8 dP   dP   `88888P' dP       `88888P'
 23 | 
 24 | *.sublime-project
 25 | *.sublime-workspace
 26 | .idea
 27 | .tags
 28 | .tags_sorted_by_file
 29 | .ropeproject
 30 | .project
 31 | .pydevproject
 32 | .settings
 33 | build
 34 | dist
 35 | .svn
 36 | *.swp
 37 | *.swo
 38 | *.bak
 39 | *~
 40 | .sass-cache
 41 | *.tmlanguage.cache
 42 | *.tmPreferences.cache
 43 | *.stTheme.cache
 44 | Session.vim
 45 | .netrwhist
 46 | 
 47 | 
 48 | #                     dP   dP
 49 | #                     88   88
 50 | # 88d888b. dP    dP d8888P 88d888b. .d8888b. 88d888b.
 51 | # 88'  `88 88    88   88   88'  `88 88'  `88 88'  `88
 52 | # 88.  .88 88.  .88   88   88    88 88.  .88 88    88
 53 | # 88Y888P' `8888P88   dP   dP    dP `88888P' dP    dP
 54 | # 88            .88
 55 | # dP        d8888P
 56 | 
 57 | # pyenv
 58 | .python-version
 59 | 
 60 | # Packages
 61 | *.egg
 62 | *.egg-info/
 63 | dist/
 64 | *.dist-info/
 65 | build/
 66 | _build/
 67 | eggs/
 68 | parts
 69 | var/
 70 | sdist/
 71 | develop-eggs
 72 | .installed.cfg
 73 | 
 74 | # Installer logs
 75 | pip-log.txt
 76 | 
 77 | # Unit test / coverage reports
 78 | .coverage
 79 | .tox
 80 | 
 81 | # Compiled Python files
 82 | *.py[cod]
 83 | 
 84 | 
 85 | # Byte-compiled / optimized / DLL files
 86 | __pycache__/
 87 | *$py.class
 88 | 
 89 | # C extensions
 90 | *.so
 91 | 
 92 | # Installer logs
 93 | pip-log.txt
 94 | pip-delete-this-directory.txt
 95 | 
 96 | # Unit test / coverage reports
 97 | htmlcov/
 98 | .tox/
 99 | .coverage
100 | .coverage.*
101 | .cache
102 | nosetests.xml
103 | coverage.xml
104 | *,cover
105 | .hypothesis/
106 | 
107 | *.log
108 | *.log.1
109 | 
110 | # Sphinx documentation
111 | docs/_build/
112 | 
113 | # Data generation scripts
114 | /lfc
115 | /goodreads
116 | 
117 | # Excel temp file
118 | ~$*.xlsx
119 | 


--------------------------------------------------------------------------------
/I-Sheet-You-Not-0.3.2.alfredworkflow:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/I-Sheet-You-Not-0.3.2.alfredworkflow


--------------------------------------------------------------------------------
/LICENCE.txt:
--------------------------------------------------------------------------------
1 | src/LICENCE.txt


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <img src="./src/icon.png" width="128" height="128">
 2 | 
 3 | I Sheet You Not
 4 | ===============
 5 | 
 6 | Create auto-updating [Alfred 3][alfred] workflows from Excel worksheets.
 7 | 
 8 | 
 9 | ![I Sheet You Not demonstration][demo]
10 | 
11 | I Sheet You Not is a workflow generator/template for [Alfred 3][alfred].
12 | It reads data from an Excel workbook and displays it in Alfred. You can specify
13 | which rows and columns the data are read from, and changes to the data are
14 | picked up automatically by the workflow.
15 | 
16 | 
17 | Download and installation
18 | -------------------------
19 | 
20 | Download the workflow from [GitHub releases][gh-releases] and double-click
21 | the downloaded `I-Sheet-You-Not-X.X.X.alfredworkflow` file to install in
22 | Alfred.
23 | 
24 | Usage
25 | -----
26 | 
27 | See [the documentation][doc] for instructions.
28 | 
29 | 
30 | Licencing, thanks
31 | -----------------
32 | 
33 | This workflow is released under the [MIT licence][mit].
34 | 
35 | It is based on the [xlrd library for Python][xlrd], released under a [BSD-style licence][xlrd-licence].
36 | 
37 | The workflow icon is from [IconArchive.com][icon].
38 | 
39 | 
40 | [alfred]: https://www.alfredapp.com/
41 | [doc]: http://www.deanishe.net/i-sheet-you-not/
42 | [demo]: doc/_static/demo.gif
43 | [gh-releases]: https://github.com/deanishe/i-sheet-you-not/releases
44 | [mit]: ./src/LICENCE.txt
45 | [icon]: http://www.iconarchive.com/show/google-jfk-icons-by-carlosjj/spreadsheets-icon.html
46 | [xlrd]: http://www.python-excel.org
47 | [xlrd-licence]: https://github.com/python-excel/xlrd/blob/master/docs/licenses.rst
48 | 


--------------------------------------------------------------------------------
/bin/build-docs.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | basedir=$(cd $(dirname $0)/../; pwd)
 4 | docdir="${basedir}/doc"
 5 | 
 6 | 
 7 | echo "========================= Building docs =============================="
 8 | 
 9 | cd "${docdir}"
10 | if [[ -d _build ]]; then
11 |   rm -rf _build/*
12 | fi
13 | make html
14 | cd -
15 | 


--------------------------------------------------------------------------------
/bin/publish-docs.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash
 2 | 
 3 | # Publish documentation to gh-pages branch using ghp-import
 4 | 
 5 | if [[ -z "$1" ]]; then
 6 |     echo "You must specify a commit message."
 7 |     exit 1
 8 | fi
 9 | 
10 | # Test that ghp-import is installed
11 | command -v ghp-import > /dev/null 2>&1 || {
12 |   echo "ghp-import not found."
13 |   echo "'pip install ghp-import' to install"
14 |   exit 1
15 | }
16 | 
17 | basedir=$(cd $(dirname $0)/../; pwd)
18 | docdir="${basedir}/doc"
19 | builddir="${docdir}/_build/html"
20 | buildscript="${basedir}/bin/build-docs.sh"
21 | 
22 | echo "\$basedir  : ${basedir}"
23 | echo "\$docdir   : ${docdir}"
24 | echo "\$builddir : ${builddir}"
25 | 
26 | # cd "${docdir}"
27 | # if [[ -d _build/html ]]; then
28 | #   rm -rf _build/html
29 | # fi
30 | # make html
31 | # cd -
32 | 
33 | /bin/bash "${buildscript}"
34 | 
35 | echo "######################################################################"
36 | echo "Publishing docs to gh-pages branch"
37 | echo "######################################################################"
38 | 
39 | # Publish $builddir to gh-pages branch
40 | ghp-import -n -p -m "$1" "${builddir}"
41 | 
42 | 


--------------------------------------------------------------------------------
/demo.gif:
--------------------------------------------------------------------------------
1 | doc/_static/demo.gif


--------------------------------------------------------------------------------
/doc/Makefile:
--------------------------------------------------------------------------------
  1 | # Makefile for Sphinx documentation
  2 | #
  3 | 
  4 | # You can set these variables from the command line.
  5 | SPHINXOPTS    =
  6 | SPHINXBUILD   = sphinx-build
  7 | PAPER         =
  8 | BUILDDIR      = _build
  9 | 
 10 | # User-friendly check for sphinx-build
 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
 13 | endif
 14 | 
 15 | # Internal variables.
 16 | PAPEROPT_a4     = -D latex_paper_size=a4
 17 | PAPEROPT_letter = -D latex_paper_size=letter
 18 | ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 19 | # the i18n builder cannot share the environment and doctrees with the others
 20 | I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 21 | 
 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
 23 | 
 24 | help:
 25 | 	@echo "Please use \`make <target>' where <target> is one of"
 26 | 	@echo "  html       to make standalone HTML files"
 27 | 	@echo "  dirhtml    to make HTML files named index.html in directories"
 28 | 	@echo "  singlehtml to make a single large HTML file"
 29 | 	@echo "  pickle     to make pickle files"
 30 | 	@echo "  json       to make JSON files"
 31 | 	@echo "  htmlhelp   to make HTML files and a HTML help project"
 32 | 	@echo "  qthelp     to make HTML files and a qthelp project"
 33 | 	@echo "  applehelp  to make an Apple Help Book"
 34 | 	@echo "  devhelp    to make HTML files and a Devhelp project"
 35 | 	@echo "  epub       to make an epub"
 36 | 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 37 | 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 38 | 	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 39 | 	@echo "  text       to make text files"
 40 | 	@echo "  man        to make manual pages"
 41 | 	@echo "  texinfo    to make Texinfo files"
 42 | 	@echo "  info       to make Texinfo files and run them through makeinfo"
 43 | 	@echo "  gettext    to make PO message catalogs"
 44 | 	@echo "  changes    to make an overview of all changed/added/deprecated items"
 45 | 	@echo "  xml        to make Docutils-native XML files"
 46 | 	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
 47 | 	@echo "  linkcheck  to check all external links for integrity"
 48 | 	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 49 | 	@echo "  coverage   to run coverage check of the documentation (if enabled)"
 50 | 
 51 | clean:
 52 | 	rm -rf $(BUILDDIR)/*
 53 | 
 54 | html:
 55 | 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 56 | 	@echo
 57 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 58 | 
 59 | dirhtml:
 60 | 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 61 | 	@echo
 62 | 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 63 | 
 64 | singlehtml:
 65 | 	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 66 | 	@echo
 67 | 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 68 | 
 69 | pickle:
 70 | 	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 71 | 	@echo
 72 | 	@echo "Build finished; now you can process the pickle files."
 73 | 
 74 | json:
 75 | 	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 76 | 	@echo
 77 | 	@echo "Build finished; now you can process the JSON files."
 78 | 
 79 | htmlhelp:
 80 | 	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 81 | 	@echo
 82 | 	@echo "Build finished; now you can run HTML Help Workshop with the" \
 83 | 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 84 | 
 85 | qthelp:
 86 | 	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 87 | 	@echo
 88 | 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 89 | 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 90 | 	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ISheetYouNot.qhcp"
 91 | 	@echo "To view the help file:"
 92 | 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ISheetYouNot.qhc"
 93 | 
 94 | applehelp:
 95 | 	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
 96 | 	@echo
 97 | 	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
 98 | 	@echo "N.B. You won't be able to view it unless you put it in" \
 99 | 	      "~/Library/Documentation/Help or install it in your application" \
100 | 	      "bundle."
101 | 
102 | devhelp:
103 | 	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
104 | 	@echo
105 | 	@echo "Build finished."
106 | 	@echo "To view the help file:"
107 | 	@echo "# mkdir -p $$HOME/.local/share/devhelp/ISheetYouNot"
108 | 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ISheetYouNot"
109 | 	@echo "# devhelp"
110 | 
111 | epub:
112 | 	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113 | 	@echo
114 | 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115 | 
116 | latex:
117 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118 | 	@echo
119 | 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
120 | 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
121 | 	      "(use \`make latexpdf' here to do that automatically)."
122 | 
123 | latexpdf:
124 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125 | 	@echo "Running LaTeX files through pdflatex..."
126 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
127 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128 | 
129 | latexpdfja:
130 | 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
131 | 	@echo "Running LaTeX files through platex and dvipdfmx..."
132 | 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
133 | 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
134 | 
135 | text:
136 | 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137 | 	@echo
138 | 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
139 | 
140 | man:
141 | 	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142 | 	@echo
143 | 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144 | 
145 | texinfo:
146 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
147 | 	@echo
148 | 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
149 | 	@echo "Run \`make' in that directory to run these through makeinfo" \
150 | 	      "(use \`make info' here to do that automatically)."
151 | 
152 | info:
153 | 	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154 | 	@echo "Running Texinfo files through makeinfo..."
155 | 	make -C $(BUILDDIR)/texinfo info
156 | 	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
157 | 
158 | gettext:
159 | 	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160 | 	@echo
161 | 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162 | 
163 | changes:
164 | 	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165 | 	@echo
166 | 	@echo "The overview file is in $(BUILDDIR)/changes."
167 | 
168 | linkcheck:
169 | 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
170 | 	@echo
171 | 	@echo "Link check complete; look for any errors in the above output " \
172 | 	      "or in $(BUILDDIR)/linkcheck/output.txt."
173 | 
174 | doctest:
175 | 	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
176 | 	@echo "Testing of doctests in the sources finished, look at the " \
177 | 	      "results in $(BUILDDIR)/doctest/output.txt."
178 | 
179 | coverage:
180 | 	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
181 | 	@echo "Testing of coverage in the sources finished, look at the " \
182 | 	      "results in $(BUILDDIR)/coverage/python.txt."
183 | 
184 | xml:
185 | 	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186 | 	@echo
187 | 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188 | 
189 | pseudoxml:
190 | 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191 | 	@echo
192 | 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
193 | 


--------------------------------------------------------------------------------
/doc/_static/config_sheet.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/doc/_static/config_sheet.png


--------------------------------------------------------------------------------
/doc/_static/custom.css:
--------------------------------------------------------------------------------
  1 | /* GitHub "fork me" ribbon */
  2 | /*
  3 | .github-fork-ribbon {
  4 | 	background-color: #333;
  5 | }
  6 | 
  7 | .versionmodified {
  8 | 	font-style: italic;
  9 | }
 10 | 
 11 | cite {
 12 | 	font-style: normal !important;
 13 | 	// color: blue !important;
 14 | 	color: #404040;
 15 | 	font-family: Consolas, "Andale Mono WT", "Andale Mono", "Lucida Console", "Lucida Sans Typewriter", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Liberation Mono", "Nimbus Mono L", Monaco, "Courier New", Courier, monospace;
 16 | 	font-size: 75%;
 17 | 	font-weight: bold;
 18 | 	background: #fff;
 19 | 	border: solid 1px #e1e4e5;
 20 | 	padding: 2px 5px;
 21 | }
 22 | 
 23 | code.literal span.pre {
 24 | 	color: #404040;
 25 | }
 26 | */
 27 | 
 28 | /* Top navigation bar */
 29 | div.related ul {
 30 | 	margin: 0.25em 1em;
 31 | }
 32 | 
 33 | /*div.section > div.topic,*/
 34 | div#contents {
 35 | 	border-left: none;
 36 | 	border-right: none;
 37 | 	background-color: inherit;
 38 | }
 39 | 
 40 | a.reference.image-reference,
 41 | a.reference.image-reference:hover,
 42 | a.reference.image-reference:active,
 43 | a.reference.image-reference:link {
 44 | 	text-decoration: none;
 45 | 	border-bottom: none;
 46 | }
 47 | 
 48 | div[class^='highlight'],
 49 | div.highlight,
 50 | div.highlight-python {
 51 | 	box-sizing: border-box;
 52 | 	-webkit-box-sizing: border-box;
 53 | 	-moz-box-sizing: border-box;
 54 | 	overflow-x: auto;
 55 | 	/*background-color: inherit;*/
 56 | 	background-color: #fff;
 57 | }
 58 | 
 59 | div[class^='highlight'] {
 60 | 	border: 1px solid #ccc;
 61 | }
 62 | 
 63 | div[class^='highlight'] div.highlight {
 64 | 	border: none;
 65 | }
 66 | 
 67 | div.linenodiv {
 68 | 	/*background-color: #fff;*/
 69 | 	padding-right: 0.25em;
 70 | 	padding-left: 0.25em;
 71 | }
 72 | 
 73 | div.highlight pre {
 74 | 	/*overflow-x: auto;*/
 75 | 	padding-left: 1em;
 76 | 	padding-right: 1em;
 77 | 	background-color: #fff;
 78 | 	/*border-left: 1px solid #ccc;*/
 79 | }
 80 | 
 81 | pre {
 82 | 	white-space: pre;
 83 | }
 84 | 
 85 | table.highlighttable {
 86 | 	border-collapse: collapse;
 87 | 	border-spacing: 0;
 88 |     display: table;
 89 |     max-width: 100%;
 90 |     margin-left: 0;
 91 |     /*background-color: #fff;*/
 92 | }
 93 | 
 94 | td.code,
 95 | td.linenos {
 96 | 	vertical-align: top;
 97 | }
 98 | 
 99 | td.linenos {
100 | 	border-right: 1px solid #ccc;
101 | }
102 | 
103 | table.highlighttable td {
104 | 	padding-left: 0;
105 | 	padding-right: 0;
106 | }
107 | 
108 | /* Grey */
109 | div.admonition, div.note, div.seealso {
110 |     background-color: #eee;
111 |     border: 1px solid #ccc;
112 | }
113 | 
114 | /* Blue */
115 |  div.tip, div.note, div.seealso {
116 | 	background-color: #e7f2fa;
117 | 	border: 1px solid #6ab0de;
118 |  }
119 | 
120 | /* Yellow */
121 | div.warning, div.important {
122 |     background-color: #fef9e9;
123 |     border: 1px solid #fbe091;
124 | }
125 | 
126 | /* Red */
127 | div.danger, div.error {
128 | 	background-color: #FCC;
129 |     border: 1px solid #FAA;
130 | }
131 | 
132 | 
133 | @media screen and (max-width: 875px) {
134 |     ul ul {
135 |         margin-left: 30px;
136 |     }
137 | }


--------------------------------------------------------------------------------
/doc/_static/demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/doc/_static/demo.gif


--------------------------------------------------------------------------------
/doc/_static/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/doc/_static/favicon.ico


--------------------------------------------------------------------------------
/doc/_static/icon_256.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/doc/_static/icon_256.png


--------------------------------------------------------------------------------
/doc/_templates/donate.html:
--------------------------------------------------------------------------------
 1 | {% if theme_gratipay_user or theme_gittip_user or theme_paypal_donate %}
 2 | 	<h3>Donate</h3>
 3 | 	{% if theme_gratipay_user or theme_gittip_user %}
 4 | 	<p>
 5 | 	Consider supporting the author on <a href="https://www.gratipay.com/">Gratipay</a>:
 6 | 	<script data-gratipay-username="{{ theme_gratipay_user or theme_gittip_user }}"
 7 | 	        data-gratipay-widget="button"
 8 | 	        src="//gttp.co/v1.js"></script>
 9 | 	</p>
10 | 	{% endif %}
11 | 	{% if theme_paypal_donate %}
12 | 	<p>
13 | 	Consider supporting the author on <a href="https://www.gratipay.com/">Gratipay</a>:
14 | 		<div class="gratipay">
15 | 			<script data-gratipay-username="{{ theme_gratipay_user or theme_gittip_user }}"
16 | 			        data-gratipay-widget="button"
17 | 			        src="//gttp.co/v1.js"></script>
18 | 		</div>
19 | 	</p>
20 | 	{% endif %}
21 | 
22 | {% endif %}
23 | 


--------------------------------------------------------------------------------
/doc/_templates/page.html:
--------------------------------------------------------------------------------
 1 | {# Import the theme's layout. #}
 2 | {%- set favicon = 'favicon.ico' %}
 3 | {%- set display_github = False %}
 4 | {%- set show_source = False %}
 5 | {% extends "!page.html" %}
 6 | 
 7 | {% block extrahead %}
 8 | {{ super() }}
 9 | {# <link rel="stylesheet" href="{{ pathto('_static/gh-fork-ribbon.css', 1) }}"> #}
10 | <!--[if lt IE 9]>
11 |   <link rel="stylesheet" href="_static/gh-fork-ribbon.ie.css">
12 | <![endif]-->
13 | <link rel="stylesheet" href="{{ pathto('_static/custom.css', 1) }}">
14 | {% endblock %}
15 | 
16 | {#
17 | {% if not dash_docset %}
18 |   {% block relbar1 %}{% endblock %}
19 | {% endif %}
20 |  #}
21 | 
22 | {% block footer %}
23 | {#
24 | <div class="github-fork-ribbon-wrapper left">
25 |     <div class="github-fork-ribbon">
26 |         <a href="https://github.com/deanishe/alfred-workflow">Fork me on GitHub</a>
27 |     </div>
28 | </div>
29 |  #}
30 | {{ super() }}
31 | 
32 | <!-- Piwik -->
33 | <script type="text/javascript">
34 |   var _paq = _paq || [];
35 |   _paq.push(['trackPageView']);
36 |   _paq.push(['enableLinkTracking']);
37 |   (function() {
38 |     var u="//deanishe.net/piwik/";
39 |     _paq.push(['setTrackerUrl', u+'piwik.php']);
40 |     _paq.push(['setSiteId', 2]);
41 |     var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
42 |     g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
43 |   })();
44 | </script>
45 | <noscript><p><img src="//deanishe.net/piwik/piwik.php?idsite=2" style="border:0;" alt="" /></p></noscript>
46 | <!-- End Piwik Code -->
47 | 
48 | {% endblock %}
49 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/__init__.py:
--------------------------------------------------------------------------------
 1 | import os
 2 | 
 3 | from alabaster import _version as version
 4 | 
 5 | 
 6 | def get_path():
 7 |     """
 8 |     Shortcut for users whose theme is next to their conf.py.
 9 |     """
10 |     # Theme directory is defined as our parent directory
11 |     return os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
12 | 
13 | 
14 | def update_context(app, pagename, templatename, context, doctree):
15 |     context['alabaster_version'] = version.__version__
16 | 
17 | def setup(app):
18 |     # add_html_theme is new in Sphinx 1.6+
19 |     if hasattr(app, 'add_html_theme'):
20 |         theme_path = os.path.abspath(os.path.dirname(__file__))
21 |         app.add_html_theme('alabaster', theme_path)
22 |     app.connect('html-page-context', update_context)
23 |     return {'version': version.__version__,
24 |             'parallel_read_safe': True}
25 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/_version.py:
--------------------------------------------------------------------------------
1 | __version_info__ = (0, 7, 10)
2 | __version__ = '.'.join(map(str, __version_info__))
3 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/about.html:
--------------------------------------------------------------------------------
 1 | {% if theme_logo %}
 2 | <p class="logo">
 3 |   <a href="{{ pathto(master_doc) }}">
 4 |     <img class="logo" src="{{ pathto('_static/' ~ theme_logo, 1) }}" alt="Logo"/>
 5 |     {% if theme_logo_name|lower == 'true' %}
 6 |     <h1 class="logo logo-name">{{ project }}</h1>
 7 |     {% endif %}
 8 |   </a>
 9 | </p>
10 | {% else %}
11 | <h1 class="logo"><a href="{{ pathto(master_doc) }}">{{ project }}</a></h1>
12 | {% endif %}
13 | 
14 | {% if theme_description %}
15 | <p class="blurb">{{ theme_description }}</p>
16 | {% endif %}
17 | 
18 | {% if theme_github_user and theme_github_repo %}
19 | {% if theme_github_button|lower == 'true' %}
20 | <p>
21 | <iframe src="https://ghbtns.com/github-btn.html?user={{ theme_github_user }}&repo={{ theme_github_repo }}&type={{ theme_github_type }}&count={{ theme_github_count }}&size=large&v=2"
22 |   allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
23 | </p>
24 | {% endif %}
25 | {% endif %}
26 | 
27 | {% if theme_travis_button|lower != 'false' %}
28 | {% if theme_travis_button|lower == 'true' %}
29 |     {% set path = theme_github_user + '/' + theme_github_repo %}
30 | {% else %}
31 |     {% set path = theme_travis_button %}
32 | {% endif %}
33 | <p>
34 | <a href="https://travis-ci.org/{{ path }}">
35 |     <img
36 |         alt="https://secure.travis-ci.org/{{ path }}.svg?branch={{ theme_badge_branch }}"
37 |         src="https://secure.travis-ci.org/{{ path }}.svg?branch={{ theme_badge_branch }}"
38 |     />
39 | </a>
40 | </p>
41 | {% endif %}
42 | 
43 | {% if theme_codecov_button|lower != 'false' %}
44 | {% if theme_codecov_button|lower == 'true' %}
45 |     {% set path = theme_github_user + '/' + theme_github_repo %}
46 | {% else %}
47 |     {% set path = theme_codecov_button %}
48 | {% endif %}
49 | <p>
50 | <a href="https://codecov.io/github/{{ path }}">
51 |     <img
52 |     alt="https://codecov.io/github/{{ path }}/coverage.svg?branch={{ theme_badge_branch }}"
53 |     src="https://codecov.io/github/{{ path }}/coverage.svg?branch={{ theme_badge_branch }}"
54 |     />
55 | </a>
56 | </p>
57 | {% endif %}
58 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/donate.html:
--------------------------------------------------------------------------------
 1 | {% if theme_gratipay_user or theme_gittip_user %}
 2 | <h3>Donate</h3>
 3 | <p>
 4 | Consider supporting the authors on <a href="https://www.gratipay.com/">Gratipay</a>:
 5 | <script data-gratipay-username="{{ theme_gratipay_user or theme_gittip_user }}"
 6 |         data-gratipay-widget="button"
 7 |         src="//gttp.co/v1.js"></script>
 8 | </p>
 9 | {% endif %}
10 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/layout.html:
--------------------------------------------------------------------------------
 1 | {%- extends "basic/layout.html" %}
 2 | 
 3 | {%- block extrahead %}
 4 |   {{ super() }}
 5 |   <link rel="stylesheet" href="{{ pathto('_static/custom.css', 1) }}" type="text/css" />
 6 |   {% if theme_touch_icon %}
 7 |     <link rel="apple-touch-icon" href="{{ pathto('_static/' ~ theme_touch_icon, 1) }}" />
 8 |   {% endif %}
 9 |   {% if theme_canonical_url %}
10 |     <link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
11 |   {% endif %}
12 |   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
13 | {% endblock %}
14 | 
15 | {# Disable base theme's top+bottom related navs; we have our own in sidebar #}
16 | {%- block relbar1 %}{% endblock %}
17 | {%- block relbar2 %}{% endblock %}
18 | 
19 | {# Nav should appear before content, not after #}
20 | {%- block content %}
21 | {%- if theme_fixed_sidebar|lower == 'true' %}
22 |   <div class="document">
23 |     {{ sidebar() }}
24 |     {%- block document %}
25 |       <div class="documentwrapper">
26 |       {%- if render_sidebar %}
27 |         <div class="bodywrapper">
28 |       {%- endif %}
29 |           <div class="body" role="main">
30 |             {% block body %} {% endblock %}
31 |           </div>
32 |       {%- if render_sidebar %}
33 |         </div>
34 |       {%- endif %}
35 |       </div>
36 |     {%- endblock %}
37 |     <div class="clearer"></div>
38 |   </div>
39 | {%- else %}
40 | {{ super() }}
41 | {%- endif %}
42 | {%- endblock %}
43 | 
44 | {%- block footer %}
45 |     <div class="footer">
46 |       {% if show_copyright %}&copy;{{ copyright }}.{% endif %}
47 |       {% if theme_show_powered_by|lower == 'true' %}
48 |       {% if show_copyright %}|{% endif %}
49 |       Powered by <a href="http://sphinx-doc.org/">Sphinx {{ sphinx_version }}</a>
50 |       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster {{ alabaster_version }}</a>
51 |       {% endif %}
52 |       {%- if show_source and has_source and sourcename %}
53 |       {% if show_copyright or theme_show_powered_by %}|{% endif %}
54 |       <a href="{{ pathto('_sources/' + sourcename, true)|e }}"
55 |           rel="nofollow">{{ _('Page source') }}</a>
56 |       {%- endif %}
57 |     </div>
58 | 
59 |     {% if theme_github_banner|lower != 'false' %}
60 |     <a href="https://github.com/{{ theme_github_user }}/{{ theme_github_repo }}" class="github">
61 |         <img style="position: absolute; top: 0; right: 0; border: 0;" src="{{ pathto('_static/' ~ theme_github_banner, 1) if theme_github_banner|lower != 'true' else 'https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png' }}" alt="Fork me on GitHub"  class="github"/>
62 |     </a>
63 |     {% endif %}
64 | 
65 |     {% if theme_analytics_id %}
66 |     <script type="text/javascript">
67 | 
68 |       var _gaq = _gaq || [];
69 |       _gaq.push(['_setAccount', '{{ theme_analytics_id }}']);
70 |       _gaq.push(['_setDomainName', 'none']);
71 |       _gaq.push(['_setAllowLinker', true]);
72 |       _gaq.push(['_trackPageview']);
73 | 
74 |       (function() {
75 |         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
76 |         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
77 |         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
78 |       })();
79 | 
80 |     </script>
81 |     {% endif %}
82 | {%- endblock %}
83 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/navigation.html:
--------------------------------------------------------------------------------
 1 | <h3>{{ _('Navigation') }}</h3>
 2 | {{ toctree(includehidden=theme_sidebar_includehidden, collapse=theme_sidebar_collapse) }}
 3 | {% if theme_extra_nav_links %}
 4 | <hr />
 5 | <ul>
 6 |     {% for text, uri in theme_extra_nav_links.items() %}
 7 |     <li class="toctree-l1"><a href="{{ uri }}">{{ text }}</a></li>
 8 |     {% endfor %}
 9 | </ul>
10 | {% endif %}
11 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/relations.html:
--------------------------------------------------------------------------------
 1 | <div class="relations">
 2 | <h3>Related Topics</h3>
 3 | <ul>
 4 |   <li><a href="{{ pathto(master_doc) }}">Documentation overview</a><ul>
 5 |   {%- for parent in parents %}
 6 |   <li><a href="{{ parent.link|e }}">{{ parent.title }}</a><ul>
 7 |   {%- endfor %}
 8 |     {%- if prev %}
 9 |       <li>Previous: <a href="{{ prev.link|e }}" title="{{ _('previous chapter')
10 |         }}">{{ prev.title }}</a></li>
11 |     {%- endif %}
12 |     {%- if next %}
13 |       <li>Next: <a href="{{ next.link|e }}" title="{{ _('next chapter')
14 |         }}">{{ next.title }}</a></li>
15 |     {%- endif %}
16 |   {%- for parent in parents %}
17 |   </ul></li>
18 |   {%- endfor %}
19 |   </ul></li>
20 | </ul>
21 | </div>
22 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/static/alabaster.css_t:
--------------------------------------------------------------------------------
  1 | {% set theme_body_bg = theme_body_bg or theme_base_bg %}
  2 | {% set theme_code_highlight_bg = theme_code_highlight_bg or theme_body_bg %}
  3 | {% set theme_sidebar_header = theme_sidebar_header or theme_gray_1 %}
  4 | {% set theme_sidebar_link = theme_sidebar_link or theme_gray_1 %}
  5 | {% set theme_anchor_hover_fg = theme_anchor_hover_fg or theme_gray_1 %}
  6 | 
  7 | {% set theme_footnote_border = theme_footnote_border or theme_gray_2 %}
  8 | {% set theme_pre_bg = theme_pre_bg or theme_gray_2 %}
  9 | 
 10 | 
 11 | {# set up admonition styling #}
 12 | {# - basic level #}
 13 | {% set theme_admonition_xref_bg = theme_admonition_xref_bg or theme_xref_bg %}
 14 | {% set theme_admonition_bg = theme_admonition_bg or theme_gray_2 %}
 15 | {% set theme_note_bg = theme_note_bg or theme_gray_2 %}
 16 | {% set theme_seealso_bg = theme_seealso_bg or theme_gray_2 %}
 17 | 
 18 | {# - critical level #}
 19 | {% set theme_danger_bg = theme_danger_bg or theme_pink_1 %}
 20 | {% set theme_danger_border = theme_danger_border or theme_pink_2 %}
 21 | {% set theme_danger_shadow = theme_danger_shadow or theme_pink_3 %}
 22 | 
 23 | {% set theme_error_bg = theme_error_bg or theme_pink_1 %}
 24 | {% set theme_error_border = theme_error_border or theme_pink_2 %}
 25 | {% set theme_error_shadow = theme_error_shadow or theme_pink_3 %}
 26 | 
 27 | {# - warning level #}
 28 | {% set theme_caution_bg = theme_caution_bg or theme_pink_1 %}
 29 | {% set theme_caution_border = theme_caution_border or theme_pink_2 %}
 30 | 
 31 | {% set theme_attention_bg = theme_attention_bg or theme_pink_1 %}
 32 | {% set theme_attention_border = theme_attention_border or theme_pink_2 %}
 33 | 
 34 | {% set theme_warn_bg = theme_warn_bg or theme_pink_1 %}
 35 | {% set theme_warn_border = theme_warn_border or theme_pink_2 %}
 36 | 
 37 | {# - normal level #}
 38 | {% set theme_important_bg = theme_important_bg or theme_gray_2 %}
 39 | {% set theme_tip_bg = theme_tip_bg or theme_gray_2 %}
 40 | {% set theme_hint_bg = theme_hint_bg or theme_gray_2 %}
 41 | 
 42 | {# /set up admonition styling #}
 43 | 
 44 | {% set theme_shadow = theme_shadow or theme_gray_2 %}
 45 | 
 46 | 
 47 | {% set theme_topic_bg = theme_topic_bg or theme_gray_2 %}
 48 | 
 49 | {% set theme_narrow_sidebar_link = theme_narrow_sidebar_link or theme_gray_3 %}
 50 | {% set theme_sidebar_hr = theme_sidebar_hr or theme_gray_3 %}
 51 | 
 52 | 
 53 | @import url("basic.css");
 54 | 
 55 | /* -- page layout ----------------------------------------------------------- */
 56 | 
 57 | body {
 58 |     font-family: {{ theme_font_family }};
 59 |     font-size: {{ theme_font_size }};
 60 |     background-color: {{ theme_base_bg }};
 61 |     color: {{ theme_base_text }};
 62 |     margin: 0;
 63 |     padding: 0;
 64 | }
 65 | 
 66 | 
 67 | div.document {
 68 |     width: {{ theme_page_width }};
 69 |     margin: 30px auto 0 auto;
 70 | }
 71 | 
 72 | div.documentwrapper {
 73 |     float: left;
 74 |     width: 100%;
 75 | }
 76 | 
 77 | div.bodywrapper {
 78 |     margin: 0 0 0 {{ theme_sidebar_width }};
 79 | }
 80 | 
 81 | div.sphinxsidebar {
 82 |     width: {{ theme_sidebar_width }};
 83 |     font-size: 14px;
 84 |     line-height: 1.5;
 85 | }
 86 | 
 87 | hr {
 88 |     border: 1px solid {{ theme_hr_border }};
 89 | }
 90 | 
 91 | div.body {
 92 |     background-color: {{ theme_body_bg  }};
 93 |     color: {{ theme_body_text }};
 94 |     padding: 0 30px 0 30px;
 95 | }
 96 | 
 97 | div.body > .section {
 98 |     text-align: {{ theme_body_text_align }};
 99 | }
100 | 
101 | div.footer {
102 |     width: {{ theme_page_width }};
103 |     margin: 20px auto 30px auto;
104 |     font-size: 14px;
105 |     color: {{ theme_footer_text }};
106 |     text-align: right;
107 | }
108 | 
109 | div.footer a {
110 |     color: {{ theme_footer_text }};
111 | }
112 | 
113 | p.caption {
114 |     font-family: {{ theme_caption_font_family }};
115 |     font-size: {{ theme_caption_font_size }};
116 | }
117 | 
118 | {% if theme_show_related|lower == 'false' %}
119 | div.relations {
120 |     display: none;
121 | }
122 | {% endif %}
123 | 
124 | div.sphinxsidebar a {
125 |     color: {{ theme_sidebar_link }};
126 |     text-decoration: none;
127 |     border-bottom: 1px dotted {{ theme_sidebar_link_underscore }};
128 | }
129 | 
130 | div.sphinxsidebar a:hover {
131 |     border-bottom: 1px solid {{ theme_sidebar_link_underscore }};
132 | }
133 | 
134 | div.sphinxsidebarwrapper {
135 |     padding: 18px 10px;
136 | }
137 | 
138 | div.sphinxsidebarwrapper p.logo {
139 |     padding: 0;
140 |     margin: -10px 0 0 0px;
141 |     text-align: center;
142 | }
143 | 
144 | div.sphinxsidebarwrapper h1.logo {
145 |     margin-top: -10px;
146 |     text-align: center;
147 |     margin-bottom: 5px;
148 |     text-align: {{ theme_logo_text_align }};
149 | }
150 | 
151 | div.sphinxsidebarwrapper h1.logo-name {
152 |     margin-top: 0px;
153 | }
154 | 
155 | div.sphinxsidebarwrapper p.blurb {
156 |     margin-top: 0;
157 |     font-style: {{ theme_description_font_style }};
158 | }
159 | 
160 | div.sphinxsidebar h3,
161 | div.sphinxsidebar h4 {
162 |     font-family: {{ theme_head_font_family }};
163 |     color: {{ theme_sidebar_header }};
164 |     font-size: 24px;
165 |     font-weight: normal;
166 |     margin: 0 0 5px 0;
167 |     padding: 0;
168 | }
169 | 
170 | div.sphinxsidebar h4 {
171 |     font-size: 20px;
172 | }
173 | 
174 | div.sphinxsidebar h3 a {
175 |     color: {{ theme_sidebar_link }};
176 | }
177 | 
178 | div.sphinxsidebar p.logo a,
179 | div.sphinxsidebar h3 a,
180 | div.sphinxsidebar p.logo a:hover,
181 | div.sphinxsidebar h3 a:hover {
182 |     border: none;
183 | }
184 | 
185 | div.sphinxsidebar p {
186 |     color: {{ theme_sidebar_text }};
187 |     margin: 10px 0;
188 | }
189 | 
190 | div.sphinxsidebar ul {
191 |     margin: 10px 0;
192 |     padding: 0;
193 |     color: {{ theme_sidebar_list }};
194 | }
195 | 
196 | div.sphinxsidebar ul li.toctree-l1 > a {
197 |     font-size: 120%;
198 | }
199 | 
200 | div.sphinxsidebar ul li.toctree-l2 > a {
201 |     font-size: 110%;
202 | }
203 | 
204 | div.sphinxsidebar input {
205 |     border: 1px solid {{ theme_sidebar_search_button }};
206 |     font-family: {{ theme_font_family }};
207 |     font-size: 1em;
208 | }
209 | 
210 | div.sphinxsidebar hr {
211 |     border: none;
212 |     height: 1px;
213 |     color: {{ theme_sidebar_hr }};
214 |     background: {{ theme_sidebar_hr }};
215 | 
216 |     text-align: left;
217 |     margin-left: 0;
218 |     width: 50%;
219 | }
220 | 
221 | /* -- body styles ----------------------------------------------------------- */
222 | 
223 | a {
224 |     color: {{ theme_link }};
225 |     text-decoration: underline;
226 | }
227 | 
228 | a:hover {
229 |     color: {{ theme_link_hover }};
230 |     text-decoration: underline;
231 | }
232 | 
233 | div.body h1,
234 | div.body h2,
235 | div.body h3,
236 | div.body h4,
237 | div.body h5,
238 | div.body h6 {
239 |     font-family: {{ theme_head_font_family }};
240 |     font-weight: normal;
241 |     margin: 30px 0px 10px 0px;
242 |     padding: 0;
243 | }
244 | 
245 | div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
246 | div.body h2 { font-size: 180%; }
247 | div.body h3 { font-size: 150%; }
248 | div.body h4 { font-size: 130%; }
249 | div.body h5 { font-size: 100%; }
250 | div.body h6 { font-size: 100%; }
251 | 
252 | a.headerlink {
253 |     color: {{ theme_anchor }};
254 |     padding: 0 4px;
255 |     text-decoration: none;
256 | }
257 | 
258 | a.headerlink:hover {
259 |     color: {{ theme_anchor_hover_fg }};
260 |     background: {{ theme_anchor_hover_bg }};
261 | }
262 | 
263 | div.body p, div.body dd, div.body li {
264 |     line-height: 1.4em;
265 | }
266 | 
267 | div.admonition {
268 |     margin: 20px 0px;
269 |     padding: 10px 30px;
270 |     background-color: {{ theme_admonition_bg }};
271 |     border: 1px solid {{ theme_admonition_border }};
272 | }
273 | 
274 | div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
275 |     background-color: {{ theme_admonition_xref_bg }};
276 |     border-bottom: 1px solid {{ theme_admonition_xref_border }};
277 | }
278 | 
279 | div.admonition p.admonition-title {
280 |     font-family: {{ theme_head_font_family }};
281 |     font-weight: normal;
282 |     font-size: 24px;
283 |     margin: 0 0 10px 0;
284 |     padding: 0;
285 |     line-height: 1;
286 | }
287 | 
288 | div.admonition p.last {
289 |     margin-bottom: 0;
290 | }
291 | 
292 | div.highlight {
293 |     background-color: {{ theme_code_highlight_bg }};
294 | }
295 | 
296 | dt:target, .highlight {
297 |     background: {{ theme_highlight_bg }};
298 | }
299 | 
300 | div.warning {
301 |     background-color: {{ theme_warn_bg }};
302 |     border: 1px solid {{ theme_warn_border }};
303 | }
304 | 
305 | div.danger {
306 |     background-color: {{ theme_danger_bg }};
307 |     border: 1px solid {{ theme_danger_border }};
308 |     -moz-box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
309 |     -webkit-box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
310 |     box-shadow: 2px 2px 4px {{ theme_danger_shadow }};
311 | }
312 | 
313 | div.error {
314 |     background-color: {{ theme_error_bg }};
315 |     border: 1px solid {{ theme_error_border }};
316 |     -moz-box-shadow: 2px 2px 4px {{ theme_error_shadow }};
317 |     -webkit-box-shadow: 2px 2px 4px {{ theme_error_shadow }};
318 |     box-shadow: 2px 2px 4px {{ theme_error_shadow }};
319 | }
320 | 
321 | div.caution {
322 |     background-color: {{ theme_caution_bg }};
323 |     border: 1px solid {{ theme_caution_border }};
324 | }
325 | 
326 | div.attention {
327 |     background-color: {{ theme_attention_bg }};
328 |     border: 1px solid {{ theme_attention_border }};
329 | }
330 | 
331 | div.important {
332 |     background-color: {{ theme_important_bg }};
333 |     border: 1px solid {{ theme_important_border }};
334 | }
335 | 
336 | div.note {
337 |     background-color: {{ theme_note_bg }};
338 |     border: 1px solid {{ theme_note_border }};
339 | }
340 | 
341 | div.tip {
342 |     background-color: {{ theme_tip_bg }};
343 |     border: 1px solid {{ theme_tip_border }};
344 | }
345 | 
346 | div.hint {
347 |     background-color: {{ theme_hint_bg }};
348 |     border: 1px solid {{ theme_hint_border }};
349 | }
350 | 
351 | div.seealso {
352 |     background-color: {{ theme_seealso_bg }};
353 |     border: 1px solid {{ theme_seealso_border }};
354 | }
355 | 
356 | div.topic {
357 |     background-color: {{ theme_topic_bg }};
358 | }
359 | 
360 | p.admonition-title {
361 |     display: inline;
362 | }
363 | 
364 | p.admonition-title:after {
365 |     content: ":";
366 | }
367 | 
368 | pre, tt, code {
369 |     font-family: {{theme_code_font_family}};
370 |     font-size: {{ theme_code_font_size }};
371 | }
372 | 
373 | .hll {
374 |     background-color: {{theme_code_highlight}};
375 |     margin: 0 -12px;
376 |     padding: 0 12px;
377 |     display: block;
378 | }
379 | 
380 | img.screenshot {
381 | }
382 | 
383 | tt.descname, tt.descclassname, code.descname, code.descclassname {
384 |     font-size: 0.95em;
385 | }
386 | 
387 | tt.descname, code.descname {
388 |     padding-right: 0.08em;
389 | }
390 | 
391 | img.screenshot {
392 |     -moz-box-shadow: 2px 2px 4px {{ theme_shadow }};
393 |     -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }};
394 |     box-shadow: 2px 2px 4px {{ theme_shadow }};
395 | }
396 | 
397 | table.docutils {
398 |     border: 1px solid {{ theme_table_border }};
399 |     -moz-box-shadow: 2px 2px 4px {{ theme_shadow }};
400 |     -webkit-box-shadow: 2px 2px 4px {{ theme_shadow }};
401 |     box-shadow: 2px 2px 4px {{ theme_shadow }};
402 | }
403 | 
404 | table.docutils td, table.docutils th {
405 |     border: 1px solid {{ theme_table_border }};
406 |     padding: 0.25em 0.7em;
407 | }
408 | 
409 | table.field-list, table.footnote {
410 |     border: none;
411 |     -moz-box-shadow: none;
412 |     -webkit-box-shadow: none;
413 |     box-shadow: none;
414 | }
415 | 
416 | table.footnote {
417 |     margin: 15px 0;
418 |     width: 100%;
419 |     border: 1px solid {{ theme_footnote_border }};
420 |     background: {{ theme_footnote_bg }};
421 |     font-size: 0.9em;
422 | }
423 | 
424 | table.footnote + table.footnote {
425 |     margin-top: -15px;
426 |     border-top: none;
427 | }
428 | 
429 | table.field-list th {
430 |     padding: 0 0.8em 0 0;
431 | }
432 | 
433 | table.field-list td {
434 |     padding: 0;
435 | }
436 | 
437 | table.field-list p {
438 |     margin-bottom: 0.8em;
439 | }
440 | 
441 | /* Cloned from
442 |  * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
443 |  */
444 | .field-name {
445 |     -moz-hyphens: manual;
446 |     -ms-hyphens: manual;
447 |     -webkit-hyphens: manual;
448 |     hyphens: manual;
449 | }
450 | 
451 | table.footnote td.label {
452 |     width: .1px;
453 |     padding: 0.3em 0 0.3em 0.5em;
454 | }
455 | 
456 | table.footnote td {
457 |     padding: 0.3em 0.5em;
458 | }
459 | 
460 | dl {
461 |     margin: 0;
462 |     padding: 0;
463 | }
464 | 
465 | dl dd {
466 |     margin-left: 30px;
467 | }
468 | 
469 | blockquote {
470 |     margin: 0 0 0 30px;
471 |     padding: 0;
472 | }
473 | 
474 | ul, ol {
475 |     /* Matches the 30px from the narrow-screen "li > ul" selector below */
476 |     margin: 10px 0 10px 30px;
477 |     padding: 0;
478 | }
479 | 
480 | pre {
481 |     background: {{ theme_pre_bg }};
482 |     padding: 7px 30px;
483 |     margin: 15px 0px;
484 |     line-height: 1.3em;
485 | }
486 | 
487 | div.viewcode-block:target {
488 |     background: {{ theme_viewcode_target_bg }};
489 | }
490 | 
491 | dl pre, blockquote pre, li pre {
492 |     margin-left: 0;
493 |     padding-left: 30px;
494 | }
495 | 
496 | tt, code {
497 |     background-color: {{ theme_code_bg }};
498 |     color: {{ theme_code_text }};
499 |     /* padding: 1px 2px; */
500 | }
501 | 
502 | tt.xref, code.xref, a tt {
503 |     background-color: {{ theme_xref_bg }};
504 |     border-bottom: 1px solid {{ theme_xref_border }};
505 | }
506 | 
507 | a.reference {
508 |     text-decoration: none;
509 |     border-bottom: 1px dotted {{ theme_link }};
510 | }
511 | 
512 | /* Don't put an underline on images */
513 | a.image-reference, a.image-reference:hover {
514 |     border-bottom: none;
515 | }
516 | 
517 | a.reference:hover {
518 |     border-bottom: 1px solid {{ theme_link_hover }};
519 | }
520 | 
521 | a.footnote-reference {
522 |     text-decoration: none;
523 |     font-size: 0.7em;
524 |     vertical-align: top;
525 |     border-bottom: 1px dotted {{ theme_link }};
526 | }
527 | 
528 | a.footnote-reference:hover {
529 |     border-bottom: 1px solid {{ theme_link_hover }};
530 | }
531 | 
532 | a:hover tt, a:hover code {
533 |     background: {{ theme_code_hover }};
534 | }
535 | 
536 | 
537 | @media screen and (max-width: 870px) {
538 | 
539 |     div.sphinxsidebar {
540 |     	display: none;
541 |     }
542 | 
543 |     div.document {
544 |        width: 100%;
545 | 
546 |     }
547 | 
548 |     div.documentwrapper {
549 |     	margin-left: 0;
550 |     	margin-top: 0;
551 |     	margin-right: 0;
552 |     	margin-bottom: 0;
553 |     }
554 | 
555 |     div.bodywrapper {
556 |     	margin-top: 0;
557 |     	margin-right: 0;
558 |     	margin-bottom: 0;
559 |     	margin-left: 0;
560 |     }
561 | 
562 |     ul {
563 |     	margin-left: 0;
564 |     }
565 | 
566 | 	li > ul {
567 |         /* Matches the 30px from the "ul, ol" selector above */
568 | 		margin-left: 30px;
569 | 	}
570 | 
571 |     .document {
572 |     	width: auto;
573 |     }
574 | 
575 |     .footer {
576 |     	width: auto;
577 |     }
578 | 
579 |     .bodywrapper {
580 |     	margin: 0;
581 |     }
582 | 
583 |     .footer {
584 |     	width: auto;
585 |     }
586 | 
587 |     .github {
588 |         display: none;
589 |     }
590 | 
591 | 
592 | 
593 | }
594 | 
595 | 
596 | 
597 | @media screen and (max-width: 875px) {
598 | 
599 |     body {
600 |         margin: 0;
601 |         padding: 20px 30px;
602 |     }
603 | 
604 |     div.documentwrapper {
605 |         float: none;
606 |         background: {{ theme_base_bg }};
607 |     }
608 | 
609 |     div.sphinxsidebar {
610 |         display: block;
611 |         float: none;
612 |         width: 102.5%;
613 |         {%- if theme_fixed_sidebar|lower == 'true' %}
614 |         margin: -20px -30px 20px -30px;
615 |         {%- else %}
616 |         margin: 50px -30px -20px -30px;
617 |         {%- endif %}
618 |         padding: 10px 20px;
619 |         background: {{ theme_narrow_sidebar_bg }};
620 |         color: {{ theme_narrow_sidebar_fg }};
621 |     }
622 | 
623 |     div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
624 |     div.sphinxsidebar h3 a {
625 |         color: {{ theme_base_bg }};
626 |     }
627 | 
628 |     div.sphinxsidebar a {
629 |         color: {{ theme_narrow_sidebar_link }};
630 |     }
631 | 
632 |     div.sphinxsidebar p.logo {
633 |         display: none;
634 |     }
635 | 
636 |     div.document {
637 |         width: 100%;
638 |         margin: 0;
639 |     }
640 | 
641 |     div.footer {
642 |         display: none;
643 |     }
644 | 
645 |     div.bodywrapper {
646 |         margin: 0;
647 |     }
648 | 
649 |     div.body {
650 |         min-height: 0;
651 |         padding: 0;
652 |     }
653 | 
654 |     .rtd_doc_footer {
655 |         display: none;
656 |     }
657 | 
658 |     .document {
659 |         width: auto;
660 |     }
661 | 
662 |     .footer {
663 |         width: auto;
664 |     }
665 | 
666 |     .footer {
667 |         width: auto;
668 |     }
669 | 
670 |     .github {
671 |         display: none;
672 |     }
673 | }
674 | 
675 | {%- if theme_fixed_sidebar|lower == 'true' %}
676 | @media screen and (min-width: 876px) {
677 |     div.sphinxsidebar {
678 |         position: fixed;
679 |         margin-left: 0;
680 |     }
681 | }
682 | {%- endif %}
683 | 
684 | 
685 | /* misc. */
686 | 
687 | .revsys-inline {
688 |     display: none!important;
689 | }
690 | 
691 | /* Make nested-list/multi-paragraph items look better in Releases changelog
692 |  * pages. Without this, docutils' magical list fuckery causes inconsistent
693 |  * formatting between different release sub-lists.
694 |  */
695 | div#changelog > div.section > ul > li > p:only-child {
696 |     margin-bottom: 0;
697 | }
698 | 
699 | /* Hide fugly table cell borders in ..bibliography:: directive output */
700 | table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
701 |   border: none;
702 |   /* Below needed in some edge cases; if not applied, bottom shadows appear */
703 |   -moz-box-shadow: none;
704 |   -webkit-box-shadow: none;
705 |   box-shadow: none;
706 | }
707 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/static/custom.css:
--------------------------------------------------------------------------------
1 | /* This file intentionally left blank. */
2 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/support.py:
--------------------------------------------------------------------------------
 1 | # flake8: noqa
 2 | 
 3 | from pygments.style import Style
 4 | from pygments.token import Keyword, Name, Comment, String, Error, \
 5 |      Number, Operator, Generic, Whitespace, Punctuation, Other, Literal
 6 | 
 7 | 
 8 | # Originally based on FlaskyStyle which was based on 'tango'.
 9 | class Alabaster(Style):
10 |     background_color = "#f8f8f8" # doesn't seem to override CSS 'pre' styling?
11 |     default_style = ""
12 | 
13 |     styles = {
14 |         # No corresponding class for the following:
15 |         #Text:                     "", # class:  ''
16 |         Whitespace:                "underline #f8f8f8",      # class: 'w'
17 |         Error:                     "#a40000 border:#ef2929", # class: 'err'
18 |         Other:                     "#000000",                # class 'x'
19 | 
20 |         Comment:                   "italic #8f5902", # class: 'c'
21 |         Comment.Preproc:           "noitalic",       # class: 'cp'
22 | 
23 |         Keyword:                   "bold #004461",   # class: 'k'
24 |         Keyword.Constant:          "bold #004461",   # class: 'kc'
25 |         Keyword.Declaration:       "bold #004461",   # class: 'kd'
26 |         Keyword.Namespace:         "bold #004461",   # class: 'kn'
27 |         Keyword.Pseudo:            "bold #004461",   # class: 'kp'
28 |         Keyword.Reserved:          "bold #004461",   # class: 'kr'
29 |         Keyword.Type:              "bold #004461",   # class: 'kt'
30 | 
31 |         Operator:                  "#582800",   # class: 'o'
32 |         Operator.Word:             "bold #004461",   # class: 'ow' - like keywords
33 | 
34 |         Punctuation:               "bold #000000",   # class: 'p'
35 | 
36 |         # because special names such as Name.Class, Name.Function, etc.
37 |         # are not recognized as such later in the parsing, we choose them
38 |         # to look the same as ordinary variables.
39 |         Name:                      "#000000",        # class: 'n'
40 |         Name.Attribute:            "#c4a000",        # class: 'na' - to be revised
41 |         Name.Builtin:              "#004461",        # class: 'nb'
42 |         Name.Builtin.Pseudo:       "#3465a4",        # class: 'bp'
43 |         Name.Class:                "#000000",        # class: 'nc' - to be revised
44 |         Name.Constant:             "#000000",        # class: 'no' - to be revised
45 |         Name.Decorator:            "#888",           # class: 'nd' - to be revised
46 |         Name.Entity:               "#ce5c00",        # class: 'ni'
47 |         Name.Exception:            "bold #cc0000",   # class: 'ne'
48 |         Name.Function:             "#000000",        # class: 'nf'
49 |         Name.Property:             "#000000",        # class: 'py'
50 |         Name.Label:                "#f57900",        # class: 'nl'
51 |         Name.Namespace:            "#000000",        # class: 'nn' - to be revised
52 |         Name.Other:                "#000000",        # class: 'nx'
53 |         Name.Tag:                  "bold #004461",   # class: 'nt' - like a keyword
54 |         Name.Variable:             "#000000",        # class: 'nv' - to be revised
55 |         Name.Variable.Class:       "#000000",        # class: 'vc' - to be revised
56 |         Name.Variable.Global:      "#000000",        # class: 'vg' - to be revised
57 |         Name.Variable.Instance:    "#000000",        # class: 'vi' - to be revised
58 | 
59 |         Number:                    "#990000",        # class: 'm'
60 | 
61 |         Literal:                   "#000000",        # class: 'l'
62 |         Literal.Date:              "#000000",        # class: 'ld'
63 | 
64 |         String:                    "#4e9a06",        # class: 's'
65 |         String.Backtick:           "#4e9a06",        # class: 'sb'
66 |         String.Char:               "#4e9a06",        # class: 'sc'
67 |         String.Doc:                "italic #8f5902", # class: 'sd' - like a comment
68 |         String.Double:             "#4e9a06",        # class: 's2'
69 |         String.Escape:             "#4e9a06",        # class: 'se'
70 |         String.Heredoc:            "#4e9a06",        # class: 'sh'
71 |         String.Interpol:           "#4e9a06",        # class: 'si'
72 |         String.Other:              "#4e9a06",        # class: 'sx'
73 |         String.Regex:              "#4e9a06",        # class: 'sr'
74 |         String.Single:             "#4e9a06",        # class: 's1'
75 |         String.Symbol:             "#4e9a06",        # class: 'ss'
76 | 
77 |         Generic:                   "#000000",        # class: 'g'
78 |         Generic.Deleted:           "#a40000",        # class: 'gd'
79 |         Generic.Emph:              "italic #000000", # class: 'ge'
80 |         Generic.Error:             "#ef2929",        # class: 'gr'
81 |         Generic.Heading:           "bold #000080",   # class: 'gh'
82 |         Generic.Inserted:          "#00A000",        # class: 'gi'
83 |         Generic.Output:            "#888",           # class: 'go'
84 |         Generic.Prompt:            "#745334",        # class: 'gp'
85 |         Generic.Strong:            "bold #000000",   # class: 'gs'
86 |         Generic.Subheading:        "bold #800080",   # class: 'gu'
87 |         Generic.Traceback:         "bold #a40000",   # class: 'gt'
88 |     }
89 | 


--------------------------------------------------------------------------------
/doc/_themes/alabaster/theme.conf:
--------------------------------------------------------------------------------
  1 | [theme]
  2 | inherit = basic
  3 | stylesheet = alabaster.css
  4 | pygments_style = alabaster.support.Alabaster
  5 | 
  6 | [options]
  7 | logo =
  8 | logo_name = false
  9 | logo_text_align = left
 10 | description =
 11 | description_font_style = normal
 12 | github_user =
 13 | github_repo =
 14 | github_button = true
 15 | github_banner = false
 16 | github_type = watch
 17 | github_count = true
 18 | badge_branch = master
 19 | travis_button = false
 20 | codecov_button = false
 21 | gratipay_user =
 22 | gittip_user =
 23 | analytics_id =
 24 | touch_icon =
 25 | canonical_url =
 26 | extra_nav_links =
 27 | sidebar_includehidden = true
 28 | sidebar_collapse = true
 29 | show_powered_by = true
 30 | show_related = false
 31 | 
 32 | gray_1 = #444
 33 | gray_2 = #EEE
 34 | gray_3 = #AAA
 35 | 
 36 | pink_1 = #FCC
 37 | pink_2 = #FAA
 38 | pink_3 = #D52C2C
 39 | 
 40 | base_bg = #fff
 41 | base_text = #000
 42 | hr_border = #B1B4B6
 43 | body_bg =
 44 | body_text = #3E4349
 45 | body_text_align = left
 46 | footer_text = #888
 47 | link = #004B6B
 48 | link_hover = #6D4100
 49 | sidebar_header =
 50 | sidebar_text = #555
 51 | sidebar_link =
 52 | sidebar_link_underscore = #999
 53 | sidebar_search_button = #CCC
 54 | sidebar_list = #000
 55 | sidebar_hr =
 56 | anchor = #DDD
 57 | anchor_hover_fg =
 58 | anchor_hover_bg = #EAEAEA
 59 | table_border = #888
 60 | shadow =
 61 | 
 62 | # Admonition options
 63 | ## basic level
 64 | admonition_bg =
 65 | admonition_border = #CCC
 66 | note_bg =
 67 | note_border = #CCC
 68 | seealso_bg =
 69 | seealso_border = #CCC
 70 | 
 71 | ## critical level
 72 | danger_bg =
 73 | danger_border =
 74 | danger_shadow =
 75 | error_bg =
 76 | error_border =
 77 | error_shadow =
 78 | 
 79 | ## normal level
 80 | tip_bg =
 81 | tip_border = #CCC
 82 | hint_bg =
 83 | hint_border = #CCC
 84 | important_bg =
 85 | important_border = #CCC
 86 | 
 87 | ## warning level
 88 | caution_bg =
 89 | caution_border =
 90 | attention_bg =
 91 | attention_border =
 92 | warn_bg =
 93 | warn_border =
 94 | 
 95 | topic_bg =
 96 | code_highlight_bg =
 97 | highlight_bg = #FAF3E8
 98 | xref_border = #fff
 99 | xref_bg = #FBFBFB
100 | admonition_xref_border = #fafafa
101 | admonition_xref_bg =
102 | footnote_bg = #FDFDFD
103 | footnote_border =
104 | pre_bg =
105 | narrow_sidebar_bg = #333
106 | narrow_sidebar_fg = #FFF
107 | narrow_sidebar_link =
108 | font_size = 17px
109 | caption_font_size = inherit
110 | viewcode_target_bg = #ffd
111 | code_bg = #ecf0f3
112 | code_text = #222
113 | code_hover = #EEE
114 | code_font_size = 0.9em
115 | code_font_family = 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace
116 | font_family = 'goudy old style', 'minion pro', 'bell mt', Georgia, 'Hiragino Mincho Pro', serif
117 | head_font_family = 'Garamond', 'Georgia', serif
118 | caption_font_family = inherit
119 | code_highlight = #FFC
120 | page_width = 940px
121 | sidebar_width = 220px
122 | fixed_sidebar = false
123 | 


--------------------------------------------------------------------------------
/doc/api.rst:
--------------------------------------------------------------------------------
 1 | 
 2 | .. _api:
 3 | 
 4 | =============
 5 | API reference
 6 | =============
 7 | 
 8 | This documentation is auto-generated from the source code.
 9 |     :members:
10 | 
11 | .. automodule:: isheetyounot
12 | 
13 | .. automodule:: isheetyounot.core
14 |     :members:
15 | 
16 | .. automodule:: isheetyounot.cli
17 |     :members:
18 | 
19 | .. automodule:: isheetyounot.aw3
20 |     :members:
21 | 


--------------------------------------------------------------------------------
/doc/changelog.rst:
--------------------------------------------------------------------------------
 1 | 
 2 | .. _changelog:
 3 | 
 4 | =========
 5 | Changelog
 6 | =========
 7 | 
 8 | 0.3.1
 9 | =====
10 | 
11 | - Add support for new-style formatting (i.e. ``format``)
12 | - Add support for Alfred 3.5's ``match`` field.
13 | 
14 | 0.3.0
15 | =====
16 | 
17 | - Add ``sprintf``- and ``strftime``-style formatting
18 | 
19 | 0.2.2
20 | =====
21 | 
22 | - Bugfix: Fix bundle ID replacement
23 | 
24 | 0.2.1
25 | =====
26 | 
27 | - Change workflow URL to point to these docs
28 | 
29 | 0.2.0
30 | =====
31 | 
32 | - Fix build error
33 | - Remove generator (red) elements from generated workflows
34 | 
35 | 0.1.2
36 | =====
37 | 
38 | - First public release
39 | 


--------------------------------------------------------------------------------
/doc/conf.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: utf-8 -*-
  2 | #
  3 | # I Sheet You Not documentation build configuration file, created by
  4 | # sphinx-quickstart on Sat Sep  3 09:58:22 2016.
  5 | #
  6 | # This file is execfile()d with the current directory set to its
  7 | # containing dir.
  8 | #
  9 | # Note that not all possible configuration values are present in this
 10 | # autogenerated file.
 11 | #
 12 | # All configuration values have a default; values that are commented out
 13 | # serve to show the default.
 14 | 
 15 | import sys
 16 | import os
 17 | 
 18 | # If extensions (or modules to document with autodoc) are in another directory,
 19 | # add these directories to sys.path here. If the directory is relative to the
 20 | # documentation root, use os.path.abspath to make it absolute, like shown here.
 21 | #sys.path.insert(0, os.path.abspath('.'))
 22 | sys.path.insert(0, os.path.abspath('../src'))
 23 | sys.path.insert(0, os.path.abspath('_themes'))
 24 | 
 25 | # -- General configuration ------------------------------------------------
 26 | 
 27 | # If your documentation needs a minimal Sphinx version, state it here.
 28 | #needs_sphinx = '1.0'
 29 | 
 30 | # Add any Sphinx extension module names here, as strings. They can be
 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 32 | # ones.
 33 | extensions = [
 34 |     'sphinx.ext.autodoc',
 35 |     'sphinx.ext.intersphinx',
 36 |     'sphinx.ext.viewcode',
 37 |     'sphinx.ext.napoleon',
 38 | ]
 39 | 
 40 | intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)}
 41 | 
 42 | # Add any paths that contain templates here, relative to this directory.
 43 | templates_path = ['_templates']
 44 | 
 45 | # The suffix(es) of source filenames.
 46 | # You can specify multiple suffix as a list of string:
 47 | # source_suffix = ['.rst', '.md']
 48 | source_suffix = '.rst'
 49 | 
 50 | # The encoding of source files.
 51 | #source_encoding = 'utf-8-sig'
 52 | 
 53 | # The master toctree document.
 54 | master_doc = 'index'
 55 | 
 56 | # General information about the project.
 57 | project = u'I Sheet You Not'
 58 | copyright = u'2016, Dean Jackson'
 59 | author = u'Dean Jackson'
 60 | 
 61 | # The version info for the project you're documenting, acts as replacement for
 62 | # |version| and |release|, also used in various other places throughout the
 63 | # built documents.
 64 | #
 65 | # The short X.Y version.
 66 | from isheetyounot.core import version
 67 | 
 68 | # The full version, including alpha/beta/rc tags.
 69 | release = version
 70 | 
 71 | # The language for content autogenerated by Sphinx. Refer to documentation
 72 | # for a list of supported languages.
 73 | #
 74 | # This is also used if you do content translation via gettext catalogs.
 75 | # Usually you set "language" from the command line for these cases.
 76 | language = 'en'
 77 | 
 78 | # There are two options for replacing |today|: either, you set today to some
 79 | # non-false value, then it is used:
 80 | #today = ''
 81 | # Else, today_fmt is used as the format for a strftime call.
 82 | #today_fmt = '%B %d, %Y'
 83 | 
 84 | # List of patterns, relative to source directory, that match files and
 85 | # directories to ignore when looking for source files.
 86 | exclude_patterns = ['_build']
 87 | 
 88 | # The reST default role (used for this markup: `text`) to use for all
 89 | # documents.
 90 | #default_role = None
 91 | 
 92 | # If true, '()' will be appended to :func: etc. cross-reference text.
 93 | #add_function_parentheses = True
 94 | 
 95 | # If true, the current module name will be prepended to all description
 96 | # unit titles (such as .. function::).
 97 | #add_module_names = True
 98 | 
 99 | # If true, sectionauthor and moduleauthor directives will be shown in the
100 | # output. They are ignored by default.
101 | #show_authors = False
102 | 
103 | # The name of the Pygments (syntax highlighting) style to use.
104 | pygments_style = 'sphinx'
105 | 
106 | # A list of ignored prefixes for module index sorting.
107 | modindex_common_prefix = ['isheetyounot.']
108 | 
109 | # If true, keep warnings as "system message" paragraphs in the built documents.
110 | #keep_warnings = False
111 | 
112 | # If true, `todo` and `todoList` produce output, else they produce nothing.
113 | todo_include_todos = False
114 | 
115 | 
116 | # -- Options for HTML output ----------------------------------------------
117 | 
118 | # The theme to use for HTML and HTML Help pages.  See the documentation for
119 | # a list of builtin themes.
120 | html_theme = 'alabaster'
121 | import alabaster
122 | html_theme_path = [alabaster.get_path()]
123 | extensions += ['alabaster']
124 | html_context = {}
125 | html_theme = 'alabaster'
126 | html_sidebars = {
127 |     '**': [
128 |         'about.html',
129 |         'localtoc.html',
130 |         'navigation.html',
131 |         # 'relations.html',
132 |         # 'searchbox.html',
133 |         'donate.html',
134 |     ]
135 | }
136 | html_theme_options = {
137 |     'logo': 'icon_256.png',
138 |     'github_button': True,
139 |     'github_user': 'deanishe',
140 |     'github_repo': 'i-sheet-you-not',
141 |     'github_type': 'star',
142 |     'gittip_user': 'deanishe',
143 |     'logo_name': True,
144 |     'logo_text_align': 'center',
145 |     'description': "Turn Excel sheets into Alfred 3 workflows.",
146 |     'font_family': "Georgia, 'goudy old style', 'minion pro', 'bell mt', 'Hiragino Mincho Pro', serif",
147 | }
148 | 
149 | # Theme options are theme-specific and customize the look and feel of a theme
150 | # further.  For a list of options available for each theme, see the
151 | # documentation.
152 | #html_theme_options = {}
153 | 
154 | # Add any paths that contain custom themes here, relative to this directory.
155 | #html_theme_path = []
156 | 
157 | # The name for this set of Sphinx documents.  If None, it defaults to
158 | # "<project> v<release> documentation".
159 | #html_title = None
160 | 
161 | # A shorter title for the navigation bar.  Default is the same as html_title.
162 | #html_short_title = None
163 | 
164 | # The name of an image file (relative to this directory) to place at the top
165 | # of the sidebar.
166 | #html_logo = None
167 | 
168 | # The name of an image file (within the static path) to use as favicon of the
169 | # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
170 | # pixels large.
171 | #html_favicon = None
172 | 
173 | # Add any paths that contain custom static files (such as style sheets) here,
174 | # relative to this directory. They are copied after the builtin static files,
175 | # so a file named "default.css" will overwrite the builtin "default.css".
176 | html_static_path = ['_static']
177 | 
178 | # Add any extra paths that contain custom files (such as robots.txt or
179 | # .htaccess) here, relative to this directory. These files are copied
180 | # directly to the root of the documentation.
181 | #html_extra_path = []
182 | 
183 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
184 | # using the given strftime format.
185 | #html_last_updated_fmt = '%b %d, %Y'
186 | 
187 | # If true, SmartyPants will be used to convert quotes and dashes to
188 | # typographically correct entities.
189 | #html_use_smartypants = True
190 | 
191 | # Custom sidebar templates, maps document names to template names.
192 | #html_sidebars = {}
193 | 
194 | # Additional templates that should be rendered to pages, maps page names to
195 | # template names.
196 | #html_additional_pages = {}
197 | 
198 | # If false, no module index is generated.
199 | #html_domain_indices = True
200 | 
201 | # If false, no index is generated.
202 | #html_use_index = True
203 | 
204 | # If true, the index is split into individual pages for each letter.
205 | #html_split_index = False
206 | 
207 | # If true, links to the reST sources are added to the pages.
208 | #html_show_sourcelink = True
209 | 
210 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
211 | #html_show_sphinx = True
212 | 
213 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
214 | #html_show_copyright = True
215 | 
216 | # If true, an OpenSearch description file will be output, and all pages will
217 | # contain a <link> tag referring to it.  The value of this option must be the
218 | # base URL from which the finished HTML is served.
219 | #html_use_opensearch = ''
220 | 
221 | # This is the file name suffix for HTML files (e.g. ".xhtml").
222 | #html_file_suffix = None
223 | 
224 | # Language to be used for generating the HTML full-text search index.
225 | # Sphinx supports the following languages:
226 | #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
227 | #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
228 | #html_search_language = 'en'
229 | 
230 | # A dictionary with options for the search language support, empty by default.
231 | # Now only 'ja' uses this config value
232 | #html_search_options = {'type': 'default'}
233 | 
234 | # The name of a javascript file (relative to the configuration directory) that
235 | # implements a search results scorer. If empty, the default will be used.
236 | #html_search_scorer = 'scorer.js'
237 | 
238 | # Output file base name for HTML help builder.
239 | htmlhelp_basename = 'ISheetYouNotdoc'
240 | 
241 | # -- Options for LaTeX output ---------------------------------------------
242 | 
243 | latex_elements = {
244 | # The paper size ('letterpaper' or 'a4paper').
245 | #'papersize': 'letterpaper',
246 | 
247 | # The font size ('10pt', '11pt' or '12pt').
248 | #'pointsize': '10pt',
249 | 
250 | # Additional stuff for the LaTeX preamble.
251 | #'preamble': '',
252 | 
253 | # Latex figure (float) alignment
254 | #'figure_align': 'htbp',
255 | }
256 | 
257 | # Grouping the document tree into LaTeX files. List of tuples
258 | # (source start file, target name, title,
259 | #  author, documentclass [howto, manual, or own class]).
260 | latex_documents = [
261 |   (master_doc, 'ISheetYouNot.tex', u'I Sheet You Not Documentation',
262 |    u'Dean Jackson', 'manual'),
263 | ]
264 | 
265 | # The name of an image file (relative to this directory) to place at the top of
266 | # the title page.
267 | #latex_logo = None
268 | 
269 | # For "manual" documents, if this is true, then toplevel headings are parts,
270 | # not chapters.
271 | #latex_use_parts = False
272 | 
273 | # If true, show page references after internal links.
274 | #latex_show_pagerefs = False
275 | 
276 | # If true, show URL addresses after external links.
277 | #latex_show_urls = False
278 | 
279 | # Documents to append as an appendix to all manuals.
280 | #latex_appendices = []
281 | 
282 | # If false, no module index is generated.
283 | #latex_domain_indices = True
284 | 
285 | 
286 | # -- Options for manual page output ---------------------------------------
287 | 
288 | # One entry per manual page. List of tuples
289 | # (source start file, name, description, authors, manual section).
290 | man_pages = [
291 |     (master_doc, 'isheetyounot', u'I Sheet You Not Documentation',
292 |      [author], 1)
293 | ]
294 | 
295 | # If true, show URL addresses after external links.
296 | #man_show_urls = False
297 | 
298 | 
299 | # -- Options for Texinfo output -------------------------------------------
300 | 
301 | # Grouping the document tree into Texinfo files. List of tuples
302 | # (source start file, target name, title, author,
303 | #  dir menu entry, description, category)
304 | texinfo_documents = [
305 |   (master_doc, 'ISheetYouNot', u'I Sheet You Not Documentation',
306 |    author, 'ISheetYouNot', 'One line description of project.',
307 |    'Miscellaneous'),
308 | ]
309 | 
310 | # Documents to append as an appendix to all manuals.
311 | #texinfo_appendices = []
312 | 
313 | # If false, no module index is generated.
314 | #texinfo_domain_indices = True
315 | 
316 | # How to display URL addresses: 'footnote', 'no', or 'inline'.
317 | #texinfo_show_urls = 'footnote'
318 | 
319 | # If true, do not generate a @detailmenu in the "Top" node's menu.
320 | #texinfo_no_detailmenu = False
321 | 
322 | 
323 | # Example configuration for intersphinx: refer to the Python standard library.
324 | # intersphinx_mapping = {'https://docs.python.org/': None}
325 | 


--------------------------------------------------------------------------------
/doc/index.rst:
--------------------------------------------------------------------------------
  1 | .. I Sheet You Not documentation master file, created by
  2 |    sphinx-quickstart on Sat Sep  3 09:58:22 2016.
  3 |    You can adapt this file completely to your liking, but it should at least
  4 |    contain the root `toctree` directive.
  5 | 
  6 | .. _index:
  7 | 
  8 | ===============
  9 | I Sheet You Not
 10 | ===============
 11 | 
 12 | Create auto-updating Alfred 3 workflows from Excel worksheets.
 13 | 
 14 | .. image:: _static/demo.gif
 15 |     :alt: I Sheet You Not demo
 16 | 
 17 | 
 18 | .. _overview:
 19 | 
 20 | Overview
 21 | ========
 22 | 
 23 | I Sheet You Not is a workflow generator/template for `Alfred 3`_. It reads
 24 | data from an Excel workbook and displays it in Alfred. You can specify
 25 | which rows and columns the data are read from, and changes to the data
 26 | are picked up automatically by the workflow.
 27 | 
 28 | 
 29 | .. _download:
 30 | 
 31 | Download and installation
 32 | =========================
 33 | 
 34 | Download the latest version of the workflow from `GitHub releases`_.
 35 | Double-click the downloaded ``I-Sheet-You-Not-X.X.X.alfredworkflow``
 36 | file to install in Alfred 3.
 37 | 
 38 | 
 39 | .. _usage:
 40 | 
 41 | Usage
 42 | =====
 43 | 
 44 | .. tip::
 45 | 
 46 |     Check out the green demo objects in the workflow for examples of how
 47 |     to use and configure I Sheet You Not.
 48 | 
 49 | Use the keyword ``isyn`` to search for an Excel sheet and generate a new
 50 | workflow based on it.
 51 | 
 52 | You will be asked to specify a name for your new workflow, which will
 53 | then be created and added to Alfred.
 54 | 
 55 | The red generator elements are removed from auto-generated workflows.
 56 | 
 57 | You should then :ref:`configure the worksheet, first row and data columns in
 58 | the workflow configuration sheet <configuration>` (if the defaults are
 59 | unsuitable).
 60 | 
 61 | Alter one of the green demo objects in the workflow to suit your purpose (e.g.
 62 | change the Keyword, Placeholder Title and Subtext) or add your own, then
 63 | delete the other, unneeded objects.
 64 | 
 65 | 
 66 | .. _configuration:
 67 | 
 68 | Configuration
 69 | =============
 70 | 
 71 | .. note::
 72 | 
 73 |     What I Sheet You Not calls the ``VALUE`` is what is typically referred to
 74 |     as ``arg`` or ``{query}`` in Alfred workflow terminology. (``arg`` being
 75 |     its name in Alfred's JSON and XML format, and ``{query}`` being the text
 76 |     macro that Alfred replaces with the value of ``arg``). It is the value
 77 |     passed to subsequent workflow elements when you "action" (i.e. hit ↩ on)
 78 |     a result shown in Alfred.
 79 | 
 80 | 
 81 | By default, the workflow pulls data from the first row of the first worksheet
 82 | in the workbook. The item title is pulled from column A, the subtitle from
 83 | column B and the value from column C.
 84 | 
 85 | To change these, use the ``SHEET``, ``START_ROW``, ``TITLE_COL``,
 86 | ``SUBTITLE_COL`` and ``VALUE_COL`` options in the workflow configuration
 87 | sheet:
 88 | 
 89 | .. image:: _static/config_sheet.png
 90 |     :alt: Workflow configuration sheet
 91 | 
 92 | ``SHEET`` may be the index number of the worksheet or the title.
 93 | If ``SHEET`` is unset, it defaults to the first worksheet.
 94 | 
 95 | If ``START_ROW`` is unset, it defaults to the first row (i.e. ``1``).
 96 | 
 97 | If ``TITLE_COL`` is unset, it defaults to the first column (i.e. ``1``, which
 98 | is column A).
 99 | 
100 | If ``SUBTITLE_COL`` is unset, it defaults to the column after ``TITLE_COL``.
101 | 
102 | If ``VALUE_COL`` is unset, it defaults to the second column after ``TITLE_COL``.
103 | 
104 | ``DATE_FORMAT`` is a `strftime`_ format string that will be used for any
105 | columns that are formatted as dates in the Excel spreadsheet. You can override
106 | this format for specific columns. See :ref:`formatting-values` below.
107 | 
108 | 
109 | .. important::
110 | 
111 |     All rows and columns must be specified as numbers, not letters, so
112 |     set ``TITLE_COL`` to ``1`` for column A, ``2`` for column B etc.
113 | 
114 |     Only the title is required. If there are no data for subtitle or
115 |     value in the spreadsheet, set ``SUBTITLE_COL`` and/or ``VALUE_COL`` to
116 |     ``0``.
117 | 
118 | 
119 | Command-line options
120 | --------------------
121 | 
122 | Configuration options may also be specified as options to the ``isyn``
123 | command within the Script Filter::
124 | 
125 |     usage: isyn [-h] [-p FILE] [-m PATTERN] [-n N] [-r N] [-t N] [-s N] [-v N]
126 |             [--version]
127 | 
128 |     I Sheet You Not. Search Excel data in Alfred 3. Pass this script the path to
129 |     an Excel file via the -p option or the DOC_PATH environment variable. By
130 |     default, the script reads the rows of the first worksheet in the workbook and
131 |     generates Alfred JSON results. It reads the first three columns, treating the
132 |     first as the result title, the second as its subtitle and the third as its
133 |     value (arg).
134 | 
135 |     optional arguments:
136 |       -h, --help            show this help message and exit
137 |       -p FILE, --docpath FILE
138 |                             Excel file to read data from. Envvar: DOC_PATH
139 |       -m PATTERN, --match PATTERN
140 |                             sprintf-style pattern for Alfred to match against
141 |                             (instead of item title). Envvar: MATCH
142 |       -n N, --sheet N       Number or name of worksheet to read data from. Default
143 |                             is the first sheet in the workbook. Envvar: SHEET
144 |       -r N, --row N         Number of first row to read data from. Default is 1,
145 |                             i.e the first row. Use --row 2 to ignore a title row,
146 |                             for example. Envvar: START_ROW
147 |       -t N, --title N       Number of column to read titles from. Default is the
148 |                             first column. Envvar: TITLE_COL
149 |       -s N, --subtitle N    Number of column to read subtitles from. Default is
150 |                             the column after the title column. Set to 0 if there
151 |                             is no subtitle column. Envvar: SUBTITLE_COL
152 |       -v N, --value N       Number of column to read values from. Default is the
153 |                             second column after the title column. Set to 0 if
154 |                             there is no value column. Envvar: VALUE_COL
155 |       --version             Show workflow version number and exit.
156 | 
157 | 
158 | 
159 | .. _setting-variables:
160 | 
161 | Extracting data to workflow variables
162 | -------------------------------------
163 | 
164 | In addition to the title, subtitle and value, you can also extract
165 | additional (or the same) columns to `workflow variables`_, which can be used
166 | by downstream workflow elements. The ``countries`` demo included with the
167 | workflow shows this technique.
168 | 
169 | To create the workflow variable ``date`` from column 8 (i.e. H), you would
170 | set the workflow/environment variable ``VAR_date=8``.
171 | 
172 | For example, the following code would extract data from the first worksheet
173 | in the Excel file, using columns A, B and C (1, 2, 3) as title, subtitle
174 | and value respectively (the default behaviour), and in addition set the
175 | workflow variables ``url`` to the data from column D (4) and ``user`` to
176 | column E (5):
177 | 
178 | .. code-block:: bash
179 |    :linenos:
180 | 
181 |    # Set workflow variable url from column 4 (D)
182 |    export VAR_url=4
183 |    # Set workflow variable user from column 5 (E)
184 |    export VAR_user=5
185 | 
186 |    ./isyn
187 | 
188 | 
189 | .. _formatting-values:
190 | 
191 | Formatting values
192 | -----------------
193 | 
194 | I Sheet You Not attempts to format your data according to the type specified
195 | by its formatting in the Excel worksheet. It is able to recognise text, number
196 | and date types. By default, text and number types are formatted "as-is", while
197 | date types are formatted according to the ``DATE_FORMAT`` specified in the
198 | workflow configuration sheet, which is a `strftime`_ format string.
199 | 
200 | (Note that Excel exports currency-formatted columns as plain numbers, so you
201 | must specify a format if you'd like to include the currency symbol in ISYN.)
202 | 
203 | You can specify alternate formats on a per-column basis by setting environment
204 | variables of the form ``FMT_N``, where ``N`` is the number of the column:
205 | 
206 | .. code-block:: bash
207 |     :linenos:
208 | 
209 |     # Format column 3 (C) as YYYY-MM-DD date
210 |     export FMT_3='%Y-%m-%d'
211 |     # Add currency symbol to column 5 (E)
212 |     # Use new-style format string to add commas
213 |     export FMT_5='$ {:,.2f}'
214 | 
215 | For text and number types, the formats are interpreted as `sprintf`_-style
216 | format strings or Python's `str.format`_-style format strings. For dates, the
217 | formats are interpreted as `strftime`_-style format strings.
218 | 
219 | .. important::
220 | 
221 |     When using ``$`` in a format string, you **must** surround it in
222 |     single-quotes (as in the above example), otherwise ``bash``/``zsh`` will
223 |     interpret it as a variable, which will fail.
224 | 
225 | 
226 | .. _matching:
227 | 
228 | Matching
229 | --------
230 | 
231 | Alfred 3.5 introduced the new ``match`` field on items. If specified, Alfred
232 | will filter your results against this field, not the item title.
233 | 
234 | You can specify the match format using the ``--match`` flag to the ``isyn``
235 | command or via the ``MATCH`` workflow variable. The ``match`` field uses
236 | `sprintf`_-style format strings and *named variables*. That is to say, you
237 | can only use variables you've extracted from your Excel sheet with ``VAR_xyz``
238 | patterns:
239 | 
240 | .. code-block:: bash
241 |     :linenos:
242 | 
243 |     # Extract a couple of variables
244 |     export VAR_name=1
245 |     export VAR_year=3
246 |     # Set the match field to include both
247 |     export MATCH='%(name)s %(year)s'
248 |     # Use first column (A) for item title and second (B) for subtitle
249 |     export TITLE_COL=1
250 |     export SUBTITLE_COL=2
251 | 
252 | The above configuration will allow you to filter items by year as well as
253 | title.
254 | 
255 | 
256 | .. _feedback:
257 | 
258 | Feedback, questions, bugs, feature requests
259 | ===========================================
260 | 
261 | If you have feedback or questions regarding I Sheet You Not, please post
262 | them in the `Alfred forum thread`_.
263 | 
264 | If you have a bug report or feature request, please create a new
265 | `GitHub issue`_.
266 | 
267 | 
268 | .. _licensing-and-thanks:
269 | 
270 | Licensing and thanks
271 | ====================
272 | 
273 | I Sheet You Not is released under the MIT License. It is based on the
274 | `xlrd library for Python`_, released under a `BSD-style licence`_.
275 | 
276 | The workflow icon was created by carlosjj from `IconArchive.com`_.
277 | 
278 | .. toctree::
279 |     :maxdepth: 2
280 | 
281 |     licence
282 | 
283 | 
284 | .. _changelog-index:
285 | 
286 | Changelog
287 | =========
288 | 
289 | .. toctree::
290 |     :maxdepth: 2
291 | 
292 |     changelog
293 | 
294 | 
295 | .. _api-index:
296 | 
297 | Auto-generated API docs
298 | =======================
299 | 
300 | This documentation was auto-generated by sphinx from the source code.
301 | 
302 | .. toctree::
303 |    :maxdepth: 2
304 | 
305 |    api
306 | 
307 | 
308 | .. _indices:
309 | 
310 | Indices and tables
311 | ==================
312 | 
313 | * :ref:`genindex`
314 | * :ref:`modindex`
315 | * :ref:`search`
316 | 
317 | 
318 | .. _Alfred 3: https://www.alfredapp.com/
319 | .. _xlrd library for Python: http://www.python-excel.org
320 | .. _BSD-style licence: https://github.com/python-excel/xlrd/blob/master/docs/licenses.rst
321 | .. _IconArchive.com: http://www.iconarchive.com/show/google-jfk-icons-by-carlosjj/spreadsheets-icon.html
322 | .. _GitHub issue: https://github.com/deanishe/i-sheet-you-not/issues
323 | .. _GitHub releases: https://github.com/deanishe/i-sheet-you-not/releases
324 | .. _Alfred forum thread: http://www.alfredforum.com/topic/9469-i-sheet-you-not-plug-excel-into-alfred/
325 | .. _workflow variables: https://www.alfredapp.com/help/workflows/advanced/variables/
326 | .. _strftime: http://strftime.org
327 | .. _sprintf: https://docs.python.org/2/library/stdtypes.html#string-formatting
328 | .. _str.format: https://docs.python.org/2.7/library/string.html#formatstrings
329 | 


--------------------------------------------------------------------------------
/doc/licence.rst:
--------------------------------------------------------------------------------
  1 | 
  2 | .. _licence:
  3 | 
  4 | =======
  5 | Licence
  6 | =======
  7 | 
  8 | I Sheet You Not is released under the MIT Licence
  9 | 
 10 | MIT License (MIT)
 11 | =================
 12 | 
 13 | Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
 14 | 
 15 | Permission is hereby granted, free of charge, to any person obtaining a copy
 16 | of this software and associated documentation files (the "Software"), to deal
 17 | in the Software without restriction, including without limitation the rights
 18 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 19 | copies of the Software, and to permit persons to whom the Software is
 20 | furnished to do so, subject to the following conditions:
 21 | 
 22 | The above copyright notice and this permission notice shall be included in
 23 | all copies or substantial portions of the Software.
 24 | 
 25 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 26 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 27 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 28 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 29 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 30 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 31 | THE SOFTWARE.
 32 | 
 33 | .. _xlrd-licences:
 34 | 
 35 | xlrd licences
 36 | =============
 37 | 
 38 | https://github.com/python-excel/xlrd/blob/master/docs/licenses.rst
 39 | 
 40 | There are two licenses associated with xlrd. This one relates to the bulk of
 41 | the work done on the library::
 42 | 
 43 |     Portions copyright © 2005-2009, Stephen John Machin, Lingfo Pty Ltd
 44 |     All rights reserved.
 45 | 
 46 |     Redistribution and use in source and binary forms, with or without
 47 |     modification, are permitted provided that the following conditions are met:
 48 | 
 49 |     1. Redistributions of source code must retain the above copyright notice,
 50 |     this list of conditions and the following disclaimer.
 51 | 
 52 |     2. Redistributions in binary form must reproduce the above copyright notice,
 53 |     this list of conditions and the following disclaimer in the documentation
 54 |     and/or other materials provided with the distribution.
 55 | 
 56 |     3. None of the names of Stephen John Machin, Lingfo Pty Ltd and any
 57 |     contributors may be used to endorse or promote products derived from this
 58 |     software without specific prior written permission.
 59 | 
 60 |     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 61 |     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 62 |     THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 63 |     PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 64 |     BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 65 |     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 66 |     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 67 |     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 68 |     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 69 |     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 70 |     THE POSSIBILITY OF SUCH DAMAGE.
 71 | 
 72 | This one covers some earlier work::
 73 | 
 74 |     /*-
 75 |      * Copyright (c) 2001 David Giffin.
 76 |      * All rights reserved.
 77 |      *
 78 |      * Based on the the Java version: Andrew Khan Copyright (c) 2000.
 79 |      *
 80 |      *
 81 |      * Redistribution and use in source and binary forms, with or without
 82 |      * modification, are permitted provided that the following conditions
 83 |      * are met:
 84 |      *
 85 |      * 1. Redistributions of source code must retain the above copyright
 86 |      *    notice, this list of conditions and the following disclaimer.
 87 |      *
 88 |      * 2. Redistributions in binary form must reproduce the above copyright
 89 |      *    notice, this list of conditions and the following disclaimer in
 90 |      *    the documentation and/or other materials provided with the
 91 |      *    distribution.
 92 |      *
 93 |      * 3. All advertising materials mentioning features or use of this
 94 |      *    software must display the following acknowledgment:
 95 |      *    "This product includes software developed by
 96 |      *     David Giffin <david@giffin.org>."
 97 |      *
 98 |      * 4. Redistributions of any form whatsoever must retain the following
 99 |      *    acknowledgment:
100 |      *    "This product includes software developed by
101 |      *     David Giffin <david@giffin.org>."
102 |      *
103 |      * THIS SOFTWARE IS PROVIDED BY DAVID GIFFIN ``AS IS'' AND ANY
104 |      * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
105 |      * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
106 |      * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DAVID GIFFIN OR
107 |      * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
108 |      * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
109 |      * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
110 |      * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
111 |      * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
112 |      * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
113 |      * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
114 |      * OF THE POSSIBILITY OF SUCH DAMAGE.
115 |      */
116 | 
117 | 


--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
1 | src/icon.png


--------------------------------------------------------------------------------
/modd.conf:
--------------------------------------------------------------------------------
1 | **/*.rst **/*.py doc/_templates/* doc/_static/* {
2 | 	prep: cd doc && make html
3 | }
4 | 
5 | doc/_build/**/* {
6 | 	daemon: devd -lm doc/_build/html/
7 | }


--------------------------------------------------------------------------------
/src/Demo.xlsx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/Demo.xlsx


--------------------------------------------------------------------------------
/src/LICENCE.txt:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.


--------------------------------------------------------------------------------
/src/buildme:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # encoding: utf-8
  3 | #
  4 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
  5 | #
  6 | # MIT Licence. See http://opensource.org/licenses/MIT
  7 | #
  8 | # Created on 2016-11-02
  9 | #
 10 | 
 11 | """Build the .alfredworkflow file for this workflow."""
 12 | 
 13 | from __future__ import print_function, absolute_import
 14 | 
 15 | import argparse
 16 | from contextlib import contextmanager
 17 | import os
 18 | from plistlib import readPlist, writePlist
 19 | from shutil import rmtree
 20 | from subprocess import Popen, check_call, PIPE, STDOUT, CalledProcessError
 21 | import sys
 22 | from uuid import uuid4
 23 | 
 24 | 
 25 | WF_NAME = 'I Sheet You Not'
 26 | BUNDLE_ID = 'net.deanishe.alfred-i-sheet-you-not'
 27 | 
 28 | UNEXPORTED_VARS = ['DEV']
 29 | 
 30 | # Generator elements. Remove these from copied workflows
 31 | GENERATOR_ELEMS = [
 32 |     '3DABB6CA-310B-4696-B4B7-B72692AEA326',  # isyn File Filter
 33 |     'D68999C3-7184-428B-9DFA-386F6517EDAC',  # isyn Script Filter
 34 |     '01FDAE7B-7189-488D-BF30-F05BDD1A8E1E',  # Excel File Action
 35 |     '6FC91D20-6F28-40E4-838E-4353FC68714E',  # Generator Run Script
 36 |     '99EB2F55-72A7-4649-85FA-DAF514ADB356',  # Args & Vars utility
 37 |     '29259774-1638-463E-AC06-9F8AAEA6B941',  # Workflow title Keyword
 38 | ]
 39 | 
 40 | # Rsync excludes for building
 41 | BUILD_EXCLUSIONS = [
 42 |     '.DS_Store',
 43 |     '*.pyc',
 44 |     'xlrd/doc',
 45 |     'xlrd/examples',
 46 |     '*.dist-info',
 47 |     '~$*.xlsx',
 48 | ]
 49 | 
 50 | HERE = os.path.dirname(__file__)
 51 | 
 52 | 
 53 | def tilde(p):
 54 |     """Replace $HOME with ~."""
 55 |     if p is None:
 56 |         return None
 57 |     h = os.path.expanduser('~')
 58 |     return p.replace(h, '~')
 59 | 
 60 | 
 61 | def abspath(p):
 62 |     """Return absolute path."""
 63 |     if p is None:
 64 |         return None
 65 |     return os.path.abspath(p)
 66 | 
 67 | 
 68 | @contextmanager
 69 | def chdir(p):
 70 |     """Change directory and back."""
 71 |     cwd = os.getcwd()
 72 |     log('cd %s', p)
 73 |     os.chdir(p)
 74 |     yield
 75 |     log('cd %s', cwd)
 76 |     os.chdir(cwd)
 77 | 
 78 | 
 79 | class Builder(object):
 80 |     """Workflow builder.
 81 | 
 82 |     Creates .alfredworkflow file
 83 |     """
 84 | 
 85 |     def __init__(self, bundle_id, name, target,
 86 |                  docpath=None, clean=False, debug=False):
 87 |         """Create new `Builder`."""
 88 |         self.bundle_id = bundle_id
 89 |         self.name = name
 90 |         self.target = abspath(target)
 91 |         self.docpath = abspath(docpath)
 92 |         self.clean = clean
 93 |         self.debug = debug
 94 |         self.builddir = self._builddir()
 95 | 
 96 |     def build(self):
 97 |         """Build .alfredworkflow file in `builddir` and save to `target`."""
 98 |         to_del = []
 99 |         if not self.debug:
100 |             to_del.append(self.builddir)
101 | 
102 |         with chdir(HERE):
103 |             try:
104 |                 self._copy()
105 |                 self._info_plist()
106 |                 self._zip()
107 |             except Exception as err:
108 |                 to_del.append(self.target)
109 |                 raise err
110 |             finally:
111 |                 tidyup(*to_del)
112 | 
113 |         log('----------------------------')
114 |         log('Name      : %s', self.name)
115 |         log('Bundle ID : %s', self.bundle_id)
116 |         log('Document  : %s', tilde(self.docpath))
117 |         log('Workflow  : %s', tilde(self.target))
118 |         log('----------------------------')
119 |         # log('%s saved in %s', os.path.basename(self.target),
120 |         #     os.path.dirname(self.target))
121 | 
122 |     def _builddir(self):
123 |         """Create unique builddir."""
124 |         fn = 'isyn.build.{:d}'.format(os.getpid())
125 |         p = os.path.join(os.path.dirname(self.target), fn)
126 |         os.makedirs(p)
127 |         return p
128 | 
129 |     def _copy(self):
130 |         """Copy workflow files to build directory."""
131 |         builddir = self.builddir
132 |         log('Copying workflow contents to %s ...', builddir)
133 |         if not builddir.endswith('/'):
134 |             builddir += '/'
135 |         cmd = [
136 |             'rsync', '--recursive', '--verbose',
137 |             '--delete-before', '--delete-excluded',
138 |             '--perms',
139 |         ]
140 |         for x in BUILD_EXCLUSIONS:
141 |             cmd.extend(['-f', '- {}'.format(x)])
142 |         cmd.extend(['./', builddir])
143 |         # log('cmd=%r', cmd)
144 |         check_call(cmd)
145 | 
146 |     def _info_plist(self):
147 |         """Update info plist."""
148 |         log('Updating info.plist ...')
149 |         with chdir(self.builddir):
150 |             info = readPlist('info.plist')
151 |             info['bundleid'] = self.bundle_id
152 |             log('bundleid=%r', self.bundle_id)
153 |             info['name'] = self.name
154 |             log('name=%r', self.name)
155 | 
156 |             newvars = {}
157 |             for k, v in info['variables'].items():
158 |                 if k not in UNEXPORTED_VARS:
159 |                     newvars[k] = v
160 |             newvars['DOC_PATH'] = self.docpath or ''
161 |             log('DOC_PATH=%r', newvars['DOC_PATH'])
162 |             info['variables'] = newvars
163 | 
164 |             if self.clean:
165 |                 log('Removing generator objects ...')
166 |                 newobj = []
167 |                 for obj in info['objects']:
168 |                     uid = obj.get('uid')
169 |                     if uid in GENERATOR_ELEMS:
170 |                         log('deleted object %s', uid)
171 |                     else:
172 |                         newobj.append(obj)
173 |                         # log('object=%r', uid)
174 |                     info['objects'] = newobj
175 | 
176 |                 for uid, conns in info['connections'].items():
177 |                     newconn = []
178 |                     for conn in conns:
179 |                         destuid = conn['destinationuid']
180 |                         if destuid in GENERATOR_ELEMS:
181 |                             log('deleted connection %s', destuid)
182 |                         else:
183 |                             newconn.append(conn)
184 |                     info['connections'][uid] = newconn
185 | 
186 |                 for uid in GENERATOR_ELEMS:
187 |                     if uid in info['uidata']:
188 |                         log('deleted UI data %s', uid)
189 |                         del info['uidata'][uid]
190 | 
191 |                 log('Stripping demo keywords ...')
192 |                 for obj in info['objects']:
193 |                     kw = obj.get('config', {}).get('keyword', '')
194 |                     if kw.startswith('isyndemo'):
195 |                         obj['config']['keyword'] = ''
196 |                         log('stripped keyword "%s"', kw)
197 | 
198 |             log('Saving updated info.plist ...')
199 |             writePlist(info, 'info.plist')
200 | 
201 |     def _zip(self):
202 |         """Create .alfredworkflow file."""
203 |         log('Creating %s ...', os.path.basename(self.target))
204 |         with chdir(self.builddir):
205 |             cmd = ['zip', '-r8n', '.png:.xlsx', self.target, '.']
206 |             check_call(cmd)
207 | 
208 | 
209 | def run_command(cmd, combine=False):
210 |     """Run command and return output."""
211 |     if combine:
212 |         p = Popen(cmd, stdout=PIPE, stderr=STDOUT)
213 |     else:
214 |         p = Popen(cmd, stdout=PIPE, stderr=PIPE)
215 | 
216 |     stdout, stderr = p.communicate()
217 |     status = p.returncode
218 | 
219 |     if status != 0:
220 |         raise CalledProcessError(status, cmd)
221 | 
222 |     if combine:
223 |         return stdout
224 | 
225 |     return (stdout, stderr)
226 | 
227 | 
228 | def log(s, *args):
229 |     """Simple STDERR logger."""
230 |     if args:
231 |         s = s % args
232 |     print(s, file=sys.stderr)
233 | 
234 | 
235 | def version():
236 |     """Return version of workflow."""
237 |     return run_command([os.path.join(HERE, 'isyn'), '--version'], True).strip()
238 | 
239 | 
240 | def filename(name=None):
241 |     """Return filename for built workflow."""
242 |     name = name or WF_NAME
243 |     name = name.replace(' ', '-').replace(':', '-').replace('/', '-')
244 |     return '{}-{}.alfredworkflow'.format(name, version())
245 | 
246 | 
247 | def random_bundleid():
248 |     """Return randomised bundle ID."""
249 |     r = uuid4().hex
250 |     return '{}.{}'.format(BUNDLE_ID, r)
251 | 
252 | 
253 | def tidyup(*paths):
254 |     """Delete paths."""
255 |     for p in paths:
256 |         if not os.path.exists(p):
257 |             continue
258 | 
259 |         log("Deleting %s...", p)
260 |         if os.path.isdir(p):
261 |             rmtree(p)
262 |         else:
263 |             os.unlink(p)
264 | 
265 | 
266 | def parse_args():
267 |     """Parse CLI options."""
268 |     p = argparse.ArgumentParser(description=__doc__)
269 |     p.add_argument(
270 |         '-b', '--bundle-id',
271 |         metavar='<ID>',
272 |         default=BUNDLE_ID,
273 |         help="Specify a bundle ID instead of the default.")
274 |     p.add_argument(
275 |         '-c', '--clean',
276 |         action='store_true',
277 |         default=False,
278 |         help="Clean the workflow (i.e. remove red generator elements)")
279 |     p.add_argument(
280 |         '-d', '--dir',
281 |         metavar='<DIR>',
282 |         default=os.getcwd(),
283 |         help="Directory to save .alfredworkflow file in.")
284 |     p.add_argument(
285 |         '-n', '--name',
286 |         metavar='<NAME>',
287 |         default=WF_NAME,
288 |         help="""The name of the workflow, e.g. "Bob's Cool Workflow".""")
289 |     p.add_argument(
290 |         '-r', '--random',
291 |         action='store_true',
292 |         default=False,
293 |         help="Generate a random bundle ID.")
294 |     p.add_argument(
295 |         '-f', '--force',
296 |         action='store_true',
297 |         default=False,
298 |         help="Overwrite any existing file.")
299 |     p.add_argument(
300 |         '-o', '--open',
301 |         action='store_true',
302 |         default=False,
303 |         help="Open in Alfred after a successful build.")
304 |     p.add_argument(
305 |         '--debug',
306 |         action='store_true',
307 |         default=False,
308 |         help="Keep builddir.")
309 | 
310 |     o = p.parse_args()
311 |     if o.random:
312 |         o.bundle_id = random_bundleid()
313 | 
314 |     o.docpath = os.getenv('DOC_PATH')
315 |     o.target = os.path.join(o.dir, filename(o.name))
316 |     log('args=%r', o)
317 |     if os.path.exists(o.target) and not o.force:
318 |         p.error("Destination file exists `{}`. "
319 |                 "Use --force to overwrite.".format(o.target))
320 | 
321 |     return o
322 | 
323 | 
324 | def main():
325 |     """Build workflow."""
326 |     o = parse_args()
327 |     b = Builder(o.bundle_id, o.name, o.target, o.docpath, o.clean, o.debug)
328 |     try:
329 |         b.build()
330 |     except Exception as err:
331 |         log('ERROR: %s', err)
332 |         return 1
333 |     if o.open:
334 |         log('Opening workflow in Alfred ...')
335 |         check_call(['open', o.target])
336 |     return 0
337 | 
338 | 
339 | if __name__ == '__main__':
340 |     sys.exit(main())
341 | 


--------------------------------------------------------------------------------
/src/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/icon.png


--------------------------------------------------------------------------------
/src/isheetyounot/__init__.py:
--------------------------------------------------------------------------------
 1 | # encoding: utf-8
 2 | #
 3 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
 4 | #
 5 | # MIT Licence. See http://opensource.org/licenses/MIT
 6 | #
 7 | # Created on 2016-05-21
 8 | #
 9 | 
10 | """
11 | I Sheet You Not
12 | ---------------
13 | 
14 | **Search Excel data in Alfred 3**
15 | 
16 | This package implements an Alfred workflow that generates *other*
17 | Alfred workflows that pull data from Excel files.
18 | 
19 | The core program can both search for and in Excel files, and works
20 | by making a copy of itself with different settings (and stripped
21 | of the workflow-generating elements in Alfred's UI).
22 | 
23 | """
24 | 
25 | from __future__ import print_function, unicode_literals, absolute_import
26 | 
27 | from .core import version as __version__
28 | from .core import (
29 |     ConfigError,
30 |     HELP_URL,
31 |     cache_data,
32 |     cache_key,
33 |     cached_data,
34 |     read_data,
35 |     tilde,
36 | )
37 | 
38 | 
39 | __all__ = [
40 |     'ConfigError',
41 |     'HELP_URL',
42 |     '__version__',
43 |     'cache_data',
44 |     'cache_key',
45 |     'cached_data',
46 |     'read_data',
47 |     'tilde',
48 | ]
49 | 


--------------------------------------------------------------------------------
/src/isheetyounot/__main__.py:
--------------------------------------------------------------------------------
 1 | # encoding: utf-8
 2 | #
 3 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
 4 | #
 5 | # MIT Licence. See http://opensource.org/licenses/MIT
 6 | #
 7 | # Created on 2016-05-21
 8 | #
 9 | 
10 | """
11 | Run the I Sheet You Not program.
12 | """
13 | 
14 | from __future__ import print_function, unicode_literals, absolute_import
15 | 
16 | from . import cli
17 | from .aw3 import rescue
18 | from .core import HELP_URL
19 | 
20 | if __name__ == '__main__':
21 |     rescue(cli.main, HELP_URL)
22 | 


--------------------------------------------------------------------------------
/src/isheetyounot/aw3.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # encoding: utf-8
  3 | #
  4 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
  5 | #
  6 | # MIT Licence. See http://opensource.org/licenses/MIT
  7 | #
  8 | # Created on 2016-05-21
  9 | #
 10 | 
 11 | """Lightweight Alfred 3 workflow library."""
 12 | 
 13 | from __future__ import print_function, unicode_literals, absolute_import
 14 | 
 15 | import json
 16 | import os
 17 | import sys
 18 | import time
 19 | from uuid import uuid4
 20 | 
 21 | 
 22 | # System error-type icon. Used by rescue() on error.
 23 | ICON_ERROR = ('/System/Library/CoreServices/CoreTypes.bundle/Contents/'
 24 |               'Resources/AlertStopIcon.icns')
 25 | 
 26 | 
 27 | def log(s, *args):
 28 |     """Print message `s` to STDERR. Run `s % args` with any `args`.
 29 | 
 30 |     Args:
 31 |         s (unicode): Message to print/format string.
 32 |         *args (object): If given, used in format string `s % args`.
 33 | 
 34 |     """
 35 |     print(s % args, file=sys.stderr)
 36 | 
 37 | 
 38 | def human_time(seconds):
 39 |     """Human-readable duration, e.g. 5m2s or 1h2m.
 40 | 
 41 |     Args:
 42 |         seconds (float): Number of seconds.
 43 | 
 44 |     Returns:
 45 |         unicode: Human-readable duration.
 46 | 
 47 |     """
 48 |     s = seconds
 49 | 
 50 |     if s < 5:
 51 |         return '{:0.2f}s'.format(s)
 52 | 
 53 |     if s < 60:
 54 |         return '{:0.0f}s'.format(s)
 55 | 
 56 |     m, s = divmod(s, 60)
 57 |     if m < 60:
 58 |         return '{:0.0f}m{:0.0f}s'.format(m, s)
 59 | 
 60 |     h, m = divmod(m, 60)
 61 |     if h < 24:
 62 |         return '{:0.0f}h{:0.0f}m'.format(h, m)
 63 | 
 64 |     d, h = divmod(h, 24)
 65 |     return '{:0.0f}d{:0.0f}h{:0.0f}m'.format(d, h, m)
 66 | 
 67 | 
 68 | def _find_upwards(fname):
 69 |     """Find file named `fname` in the current directory or above.
 70 | 
 71 |     Args:
 72 |         fname (unicode): Filename
 73 | 
 74 |     Returns:
 75 |         unicode: Absolute path to file or `None`.
 76 | 
 77 |     """
 78 |     dirpath = os.path.abspath(os.path.dirname(__file__))
 79 |     while True:
 80 |         p = os.path.join(dirpath, fname)
 81 |         if os.path.exists(p):
 82 |             log('Found `%s` at `%s`', fname, p)
 83 |             return p
 84 |         if dirpath == '/':
 85 |             return None
 86 |         dirpath = os.path.dirname(dirpath)
 87 | 
 88 | 
 89 | def run_command(cmd):
 90 |     """Run command and return output.
 91 | 
 92 |     Args:
 93 |         cmd (sequence): Sequence or arguments to pass to `Popen`
 94 | 
 95 |     Returns:
 96 |         tuple: `(stdout, stderr)`
 97 | 
 98 |     Raises:
 99 |         CalledProcessError: Raised if command exits with non-zero status
100 | 
101 |     """
102 |     from subprocess import Popen, CalledProcessError
103 |     p = Popen(cmd)
104 |     stdout, stderr = p.communicate()
105 |     if p.returncode != 0:
106 |         raise CalledProcessError(p.returncode, cmd)
107 |     return (stdout, stderr)
108 | 
109 | 
110 | class AttrDict(dict):
111 |     """Dictionary whose keys are also accessible as attributes."""
112 | 
113 |     def __init__(self, *args, **kwargs):
114 |         """Create new `AttrDict`.
115 | 
116 |         Args:
117 |             *args (objects): Arguments to `dict.__init__()`
118 |             **kwargs (objects): Keyword arguments to `dict.__init__()`
119 | 
120 |         """
121 |         super(AttrDict, self).__init__(*args, **kwargs)
122 | 
123 |     def __getattr__(self, key):
124 |         """Look up attribute as dictionary key.
125 | 
126 |         Args:
127 |             key (str): Dictionary key/attribute name.
128 | 
129 |         Returns:
130 |             obj: Dictionary value for `key`.
131 | 
132 |         Raises:
133 |             AttributeError: Raised if `key` isn't in dictionary.
134 | 
135 |         """
136 |         if key not in self:
137 |             raise AttributeError(
138 |                 "AttrDict object has no attribute '{}'".format(key))
139 | 
140 |         return self[key]
141 | 
142 |     def __setattr__(self, key, value):
143 |         """Add `value` to the dictionary under `key`.
144 | 
145 |         Args:
146 |             key (str): Dictionary key/attribute name.
147 |             value (obj): Value to store for `key`.
148 | 
149 |         """
150 |         self[key] = value
151 | 
152 | 
153 | def alfred_vars():
154 |     """Dictionary of Alfred's environment variables w/out ``alfred_`` prefix."""
155 |     d = AttrDict()
156 |     for k in os.environ:
157 |         if k.startswith('alfred_'):
158 |             d[k[7:]] = os.environ[k]
159 |     return d
160 | 
161 | 
162 | av = alfred_vars()
163 | 
164 | 
165 | class Feedback(object):
166 |     """Alfred 3 JSON results.
167 | 
168 |     Attributes:
169 |         items (list): Sequence of `dicts` as generated by `make_item()`.
170 | 
171 |     """
172 | 
173 |     def __init__(self, items=None):
174 |         """Create new `Feedback` object.
175 | 
176 |         Args:
177 |             items (list, optional): Initial items.
178 | 
179 |         """
180 |         # self.vars = {}
181 |         # self.config = {}
182 |         self.items = items or []
183 | 
184 |     def __str__(self):
185 |         """Alfred 3 JSON format."""
186 |         return json.dumps({'items': self.items}, indent=2)
187 | 
188 |     def send(self):
189 |         """Send self as results to Alfred 3."""
190 |         print(str(self))
191 | 
192 | 
193 | def make_item(title, subtitle='', arg=None, icon=None, match=None, **wfvars):
194 |     """Create new Alfred 3 result.
195 | 
196 |     Args:
197 |         title (unicode): Title of the result.
198 |         subtitle (unicode, optional): Subtitle of the result.
199 |         arg (unicode, optional): Arg (value) of the result.
200 |         icon (unicode, optional): Path to icon for result.
201 |         match (str, optional): Match field.
202 |         **wfvars (dict): Unicode values to set as Alfred workflow variables
203 |             with this result.
204 | 
205 |     Returns:
206 |         dict: Alfred result.
207 | 
208 |     """
209 |     it = {
210 |         'title': title,
211 |         'subtitle': subtitle,
212 |         # 'autocomplete': title,
213 |         'text': {
214 |             'copy': title,
215 |             'largetype': title,
216 |         },
217 |         'valid': False,
218 |     }
219 | 
220 |     if arg:
221 |         it['arg'] = arg
222 |         it['valid'] = True
223 |         it['text'] = {
224 |             'copy': arg,
225 |             'largetype': arg,
226 |         }
227 | 
228 |     if match:
229 |         it['match'] = match
230 | 
231 |     if icon is not None:
232 |         it['icon'] = {'path': icon}
233 | 
234 |     if wfvars:
235 |         payload = {'alfredworkflow': {'arg': it.get('arg'),
236 |                                       'variables': wfvars}}
237 |         it['arg'] = json.dumps(payload)
238 | 
239 |     return it
240 | 
241 | 
242 | def rescue(fn, help_url=None):
243 |     """Wrap callable `fn`, and catch and log any exceptions it raises.
244 | 
245 |     Any captured exception is logged to STDERR and also sent to Alfred
246 |     as a result.
247 | 
248 |     Args:
249 |         fn (callable): Function/method to call in try ... except block.
250 |         help_url (unicode, optional): URL to show when an exception is caught.
251 | 
252 |     """
253 |     st = time.time()
254 | 
255 |     try:
256 |         fn()
257 |     except Exception as err:
258 |         from traceback import print_exc
259 | 
260 |         log('################ FATAL ERROR ##################')
261 |         print_exc(file=sys.stderr)
262 |         log('################# END ERROR ###################')
263 |         if help_url:
264 |             log("Find assistance at: %s", help_url)
265 | 
266 |         # log('%r\n%s', sys.exc_info()[2], err)
267 |         fb = Feedback()
268 |         fb.items = [make_item('Fatal error in workflow', unicode(err),
269 |                               icon=ICON_ERROR)]
270 |         print(fb)
271 | 
272 |     log('--------------- %0.3fs elapsed ---------------', time.time() - st)
273 | 
274 | 
275 | def random_bundle_id(prefix=None):
276 |     """Generate random bundle ID based on UUID4.
277 | 
278 |     Args:
279 |         prefix (unicode, optional): Prefix for the new bundle ID.
280 | 
281 |     Returns:
282 |         unicode: Random bundle ID of form `prefix` + `UUID4`.
283 | 
284 |     """
285 |     out = []
286 | 
287 |     if prefix:
288 |         out.append(prefix)
289 | 
290 |     out.append(uuid4().hex)
291 | 
292 |     return ''.join(out)
293 | 
294 | 
295 | def change_bundle_id(newid):
296 |     """Change the bundle ID of the current workflow.
297 | 
298 |     WARNING: The change will not apply for the current run of the workflow.
299 | 
300 |     Args:
301 |         newid (unicode): New bundle ID.
302 | 
303 |     """
304 |     ip = _find_upwards('info.plist')
305 |     pbcmd = 'Set :bundleid {}'.format(newid)
306 |     cmd = ['/usr/libexec/PlistBuddy', '-c', pbcmd, ip]
307 |     log('cmd=%r', cmd)
308 |     run_command(cmd)
309 | 


--------------------------------------------------------------------------------
/src/isheetyounot/cli.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # encoding: utf-8
  3 | #
  4 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
  5 | #
  6 | # MIT Licence. See http://opensource.org/licenses/MIT
  7 | #
  8 | # Created on 2016-05-21
  9 | #
 10 | 
 11 | """
 12 | cli
 13 | ^^^
 14 | 
 15 | Command-line interface for the Alfred workflow.
 16 | 
 17 | Will probably die in flames if not run from Alfred or an Alfred-like
 18 | environment.
 19 | 
 20 | """
 21 | 
 22 | from __future__ import print_function, unicode_literals, absolute_import
 23 | 
 24 | import argparse
 25 | import time
 26 | import os
 27 | 
 28 | from .core import (
 29 |     BUNDLE_ID,
 30 |     HELP_URL,
 31 |     ConfigError,
 32 |     cache_data,
 33 |     cache_key,
 34 |     cached_data,
 35 |     read_data,
 36 |     version,
 37 | )
 38 | from .aw3 import (
 39 |     Feedback,
 40 |     av,
 41 |     change_bundle_id,
 42 |     human_time,
 43 |     log,
 44 |     random_bundle_id,
 45 | )
 46 | 
 47 | __usage__ = """I Sheet You Not. Search Excel data in Alfred 3.
 48 | 
 49 | Pass this script the path to an Excel file via the -p option or the
 50 | DOC_PATH environment variable.
 51 | 
 52 | By default, the script reads the rows of the first worksheet in the
 53 | workbook and generates Alfred JSON results.
 54 | 
 55 | It reads the first three columns, treating the first as the result title,
 56 | the second as its subtitle and the third as its value (arg).
 57 | 
 58 | """
 59 | 
 60 | 
 61 | def parse_args():
 62 |     """Read program options from the environment and command line.
 63 | 
 64 |     Returns:
 65 |         argparse.Namespace: Program configuration.
 66 | 
 67 |     """
 68 |     p = argparse.ArgumentParser(description=__usage__)
 69 |     p.add_argument('-p', '--docpath',
 70 |                    metavar='FILE', type=str,
 71 |                    default=os.getenv('DOC_PATH') or './Demo.xlsx',
 72 |                    help="Excel file to read data from. "
 73 |                    "Envvar: DOC_PATH")
 74 |     p.add_argument('-m', '--match',
 75 |                    metavar='PATTERN', type=str,
 76 |                    default=os.getenv('MATCH') or '',
 77 |                    help="sprintf-style pattern for Alfred to match "
 78 |                    "against (instead of item title). "
 79 |                    "Envvar: MATCH")
 80 |     p.add_argument('-n', '--sheet',
 81 |                    metavar='N', type=str,
 82 |                    default=os.getenv('SHEET') or '1',
 83 |                    help="Number or name of worksheet to read data from. "
 84 |                    "Default is the first sheet in the workbook. "
 85 |                    "Envvar: SHEET")
 86 |     p.add_argument('-r', '--row',
 87 |                    dest='start_row',
 88 |                    metavar='N', type=str,
 89 |                    default=os.getenv('START_ROW') or '1',
 90 |                    help="Number of first row to read data from. "
 91 |                    "Default is 1, i.e the first row. "
 92 |                    "Use --row 2 to ignore a title row, for example. "
 93 |                    "Envvar: START_ROW")
 94 |     p.add_argument('-t', '--title',
 95 |                    dest='title_col',
 96 |                    metavar='N', type=str,
 97 |                    default=os.getenv('TITLE_COL') or '1',
 98 |                    help="Number of column to read titles from. "
 99 |                    "Default is the first column. "
100 |                    "Envvar: TITLE_COL")
101 |     p.add_argument('-s', '--subtitle',
102 |                    dest='subtitle_col',
103 |                    metavar='N', type=str,
104 |                    default=os.getenv('SUBTITLE_COL'),
105 |                    help="Number of column to read subtitles from. "
106 |                    "Default is the column after the title column. "
107 |                    "Set to 0 if there is no subtitle column. "
108 |                    "Envvar: SUBTITLE_COL")
109 |     p.add_argument('-v', '--value',
110 |                    dest='value_col',
111 |                    metavar='N', type=str,
112 |                    default=os.getenv('VALUE_COL'),
113 |                    help="Number of column to read values from. "
114 |                    "Default is the second column after the title column. "
115 |                    "Set to 0 if there is no value column. "
116 |                    "Envvar: VALUE_COL")
117 |     p.add_argument('--version', action='version', version=version,
118 |                    help="Show workflow version number and exit.")
119 | 
120 |     args = p.parse_args()
121 |     args.docpath = os.path.expanduser(args.docpath)
122 | 
123 |     # Read VAR_ABC= and FMT_N= values from the environment
124 |     evars = {}
125 |     formats = {}
126 |     for k in os.environ:
127 |         k = k.decode('utf-8')
128 |         if k.startswith('VAR_'):
129 |             v = os.environ[k].decode('utf-8')
130 |             if v and v.isdigit():
131 |                 evars[k[4:]] = int(v)
132 |             else:
133 |                 log('invalid value for "%s": %r', k, v)
134 | 
135 |         elif k.startswith('FMT_'):
136 |             key = k[4:]
137 |             v = os.environ[k].decode('utf-8')
138 |             if v and key.isdigit():
139 |                 formats[int(key)] = v
140 |             else:
141 |                 log('invalid format for "%s": %r', k, v)
142 | 
143 |     args.variables = evars
144 |     args.formats = formats
145 |     # args.alfred = alfred_vars()
146 | 
147 |     return args
148 | 
149 | 
150 | def main():
151 |     """Run workflow script."""
152 |     o = parse_args()
153 | 
154 |     log('options=%r', o)
155 | 
156 |     if not o.docpath:
157 |         raise ConfigError("You must set DOC_PATH in the workflow "
158 |                           "configuration sheet.")
159 | 
160 |     if not os.path.exists(o.docpath):
161 |         raise ConfigError("File does not exist : {}".format(o.docpath))
162 | 
163 |     # ---------------------------------------------------------
164 |     # Ensure the bundle ID is *not* the default (so we can have
165 |     # lots of copies of the workflow)
166 |     #
167 |     # TODO: Replace this when the workflow can create copies of itself.
168 | 
169 |     log('------ alfred env vars -------')
170 |     for k, v in sorted(av.items()):
171 |         log('%s=%r', k, v)
172 |     log('------------------------------')
173 | 
174 |     if av.get('workflow_bundleid', '') == BUNDLE_ID and not os.getenv('DEV'):
175 |         newid = random_bundle_id(BUNDLE_ID + '.')
176 |         log('Changing bundle ID to %r ...', newid)
177 |         change_bundle_id(newid)
178 |         av['workflow_bundleid'] = newid
179 | 
180 |     # ---------------------------------------------------------
181 |     # Check for valid cached data
182 | 
183 |     key = cache_key(o)
184 |     doc_age = time.time() - os.path.getmtime(o.docpath)
185 |     log('doc_age=%s', human_time(doc_age))
186 |     cached = cached_data(key, max_age=doc_age)
187 |     if cached:
188 |         log('Using cached data.')
189 |         print(cached)
190 |         return 0
191 | 
192 |     # ---------------------------------------------------------
193 |     # Data coordinates
194 | 
195 |     start_row = int(o.start_row)
196 |     t = int(o.title_col)
197 | 
198 |     if not o.subtitle_col:
199 |         s = t + 1
200 |     else:
201 |         s = int(o.subtitle_col)
202 | 
203 |     if not o.value_col:
204 |         v = t + 2
205 |     else:
206 |         v = int(o.value_col)
207 | 
208 |     cols = [t, s, v]
209 | 
210 |     log('sheet=%r, start_row=%d, cols=%r, vars=%r, formats=%r', o.sheet,
211 |         start_row, cols, o.variables, o.formats)
212 | 
213 |     # ---------------------------------------------------------
214 |     # Generate and cache output
215 | 
216 |     s = time.time()
217 |     items = read_data(o.docpath, o.sheet, cols, start_row,
218 |                       o.variables, o.formats, o.match)
219 |     js = str(Feedback(items))
220 |     cache_data(key, js)
221 |     print(js)
222 |     d = time.time() - s
223 |     log('Updated cache in %s', human_time(d))
224 | 
225 |     return 0
226 | 
227 | 
228 | if __name__ == '__main__':
229 |     from .aw3 import rescue
230 |     rescue(main, HELP_URL)
231 | 


--------------------------------------------------------------------------------
/src/isheetyounot/core.py:
--------------------------------------------------------------------------------
  1 | #!/usr/bin/env python
  2 | # encoding: utf-8
  3 | #
  4 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
  5 | #
  6 | # MIT Licence. See http://opensource.org/licenses/MIT
  7 | #
  8 | # Created on 2016-05-21
  9 | #
 10 | 
 11 | """I Sheet You Not. Search Excel data in Alfred 3.
 12 | 
 13 | Pass this script the path to an Excel file via the -p option or the
 14 | DOC_PATH environment variable.
 15 | 
 16 | By default, the script reads the rows of the first worksheet in the
 17 | workbook and generates Alfred JSON results.
 18 | 
 19 | It reads the first three columns, treating the first as the result title,
 20 | the second as its subtitle and the third as its value (arg).
 21 | 
 22 | """
 23 | 
 24 | from __future__ import print_function, unicode_literals, absolute_import
 25 | 
 26 | import hashlib
 27 | import os
 28 | import time
 29 | 
 30 | from .aw3 import av, human_time, log, make_item
 31 | 
 32 | from xlrd import (
 33 |     XL_CELL_EMPTY as TYPE_EMPTY,
 34 |     XL_CELL_TEXT as TYPE_TEXT,
 35 |     XL_CELL_NUMBER as TYPE_NUMBER,
 36 |     XL_CELL_DATE as TYPE_DATE,
 37 |     XL_CELL_BOOLEAN as TYPE_BOOLEAN,
 38 |     XL_CELL_ERROR as TYPE_ERROR,
 39 |     XL_CELL_BLANK as TYPE_BLANK,
 40 | )
 41 | from xlrd.xldate import xldate_as_datetime
 42 | 
 43 | # Workflow version number
 44 | version = '0.3.2'
 45 | 
 46 | # Fallback/default values
 47 | BUNDLE_ID = 'net.deanishe.alfred-i-sheet-you-not'
 48 | CACHE_DIR = os.path.join(os.path.expanduser('~/Library/Caches'), BUNDLE_ID)
 49 | 
 50 | # Link to GitHub issues. Output by rescue() on error.
 51 | HELP_URL = 'https://github.com/deanishe/i-sheet-you-not/issues'
 52 | 
 53 | # Excel's start date + 1 day (Jan 0 doesn't exist in Python)
 54 | # START_DATE = date(1900, 1, 1)
 55 | DEFAULT_DATE_FORMAT = '%Y-%m-%d'
 56 | DATE_FORMAT = os.getenv('DATE_FORMAT') or DEFAULT_DATE_FORMAT
 57 | 
 58 | 
 59 | class ConfigError(Exception):
 60 |     """Raised if a configuration value is not given or invalid.
 61 | 
 62 |     Typically, this will be a bad sheet number or name.
 63 | 
 64 |     If the program can't read the Excel data for other reasons,
 65 |     there'll be an exception from the underlying `xlrd` library.
 66 | 
 67 |     """
 68 | 
 69 |     pass
 70 | 
 71 | 
 72 | # dP                dP
 73 | # 88                88
 74 | # 88d888b. .d8888b. 88 88d888b. .d8888b. 88d888b. .d8888b.
 75 | # 88'  `88 88ooood8 88 88'  `88 88ooood8 88'  `88 Y8ooooo.
 76 | # 88    88 88.  ... 88 88.  .88 88.  ... 88             88
 77 | # dP    dP `88888P' dP 88Y888P' `88888P' dP       `88888P'
 78 | #                      88
 79 | #                      dP
 80 | 
 81 | 
 82 | def tilde(path):
 83 |     """Replace user's home directory in `path` with ~.
 84 | 
 85 |     Args:
 86 |         path (unicode): A filepath.
 87 | 
 88 |     Returns:
 89 |         unicode: Shortened filepath.
 90 |     """
 91 |     return path.replace(os.getenv('HOME'), '~')
 92 | 
 93 | 
 94 | #                            dP       oo
 95 | #                            88
 96 | # .d8888b. .d8888b. .d8888b. 88d888b. dP 88d888b. .d8888b.
 97 | # 88'  `"" 88'  `88 88'  `"" 88'  `88 88 88'  `88 88'  `88
 98 | # 88.  ... 88.  .88 88.  ... 88    88 88 88    88 88.  .88
 99 | # `88888P' `88888P8 `88888P' dP    dP dP dP    dP `8888P88
100 | #                                                      .88
101 | #                                                  d8888P
102 | 
103 | def cache_key(o):
104 |     """Generate unique, deterministic key based on program options.
105 | 
106 |     Args:
107 |         o (argparse.Namespace): Program's configuration object.
108 | 
109 |     Returns:
110 |         str: MD5 hex digest of options.
111 | 
112 |     """
113 |     # Cache key of full path and *all* variables to ensure uniqueness
114 |     p = os.path.abspath(o.docpath)
115 |     v = '-'.join([
116 |         '{}={}'.format(k, v) for
117 |         k, v in sorted(o.variables.items() + o.formats.items())
118 |     ])
119 | 
120 |     tpl = ('{p}-{o.sheet}-{o.start_row}-{o.title_col}-'
121 |            '{o.subtitle_col}-{o.value_col}-{o.match}-{v}')
122 | 
123 |     n = tpl.format(p=p, o=o, v=v)
124 |     return hashlib.md5(n.encode('utf-8')).hexdigest()
125 | 
126 | 
127 | def _cache_path(key):
128 |     """Path for cached JSON based on key and workflow's cache directory.
129 | 
130 |     Args:
131 |         key (str): Unique key from `cache_key()`.
132 | 
133 |     Returns:
134 |         unicode: Filepath in cache directory with ".json" extension.
135 | 
136 |     """
137 |     root = av.get('workflow_cache', CACHE_DIR)
138 |     # log('cache_dir=%r', root)
139 |     par = [key[:3], key[3:6], key[6:9]]
140 |     dp = os.path.join(root, *par)
141 | 
142 |     # log('cache_dir=%r', tilde(dp))
143 | 
144 |     try:
145 |         os.makedirs(dp, 0700)
146 |     except OSError:
147 |         pass
148 | 
149 |     p = os.path.join(dp, '{}.json'.format(key))
150 | 
151 |     log('cache_path=%r', tilde(p))
152 | 
153 |     return p
154 | 
155 | 
156 | def cached_data(key, max_age=0):
157 |     """Returned data cached for `key` or `None`.
158 | 
159 |     Returns `None` if no data are cached for `key` or the age
160 |     of the cached data exceeds `max_age` (if `max_age` is non-zero).
161 | 
162 |     Args:
163 |         key (str): Cache key from `cache_key()`.
164 |         max_age (int, optional): Maximum permissible age of cached data
165 |             in seconds.
166 | 
167 |     Returns:
168 |         str: The contents of the cache file, or `None`.
169 |     """
170 |     p = _cache_path(key)
171 | 
172 |     if not os.path.exists(p):
173 |         return None
174 | 
175 |     if max_age:
176 |         age = time.time() - os.path.getmtime(p)
177 |         log('cache_age=%s', human_time(age))
178 | 
179 |         if age > max_age:
180 |             return None
181 | 
182 |     with open(p) as fp:
183 |         return fp.read()
184 | 
185 | 
186 | def cache_data(key, data):
187 |     """Store `data` in cache under name `key`.
188 | 
189 |     Args:
190 |         key (str): Cache key from `cache_key()`.
191 |         data (str): Data to write to file.
192 |     """
193 |     p = _cache_path(key)
194 | 
195 |     with open(p, 'wb') as fp:
196 |         fp.write(data)
197 | 
198 | 
199 | #                                     dP
200 | #                                     88
201 | # .d8888b. dP.  .dP .d8888b. .d8888b. 88
202 | # 88ooood8  `8bd8'  88'  `"" 88ooood8 88
203 | # 88.  ...  .d88b.  88.  ... 88.  ... 88
204 | # `88888P' dP'  `dP `88888P' `88888P' dP
205 | 
206 | 
207 | def cell_type(cell):
208 |     """Return type of cell.
209 | 
210 |     Args:
211 |         cell (xlrd.sheet.Cell): Excel cell
212 | 
213 |     Returns:
214 |         str: Type of cell as text
215 |     """
216 |     if cell.ctype == TYPE_BLANK:
217 |         return 'blank'
218 |     if cell.ctype == TYPE_BOOLEAN:
219 |         return 'boolean'
220 |     if cell.ctype == TYPE_DATE:
221 |         return 'date'
222 |     if cell.ctype == TYPE_EMPTY:
223 |         return 'empty'
224 |     if cell.ctype == TYPE_ERROR:
225 |         return 'error'
226 |     if cell.ctype == TYPE_NUMBER:
227 |         return 'number'
228 |     if cell.ctype == TYPE_TEXT:
229 |         return 'text'
230 | 
231 | 
232 | class Formatter(object):
233 |     """Format Excel values according to column-specific format strings.
234 | 
235 |     Format strings should be sprintf- or strftime-style (for date columns)
236 |     patterns.
237 | 
238 |     Attributes:
239 |         datemode (int): Date mode of sheet this formatter is for
240 |         formats (dict): Column -> format string mapping
241 | 
242 |     """
243 | 
244 |     def __init__(self, datemode, formats=None):
245 |         self.datemode = datemode
246 |         self.formats = {}
247 |         formats = formats or {}
248 |         for col, pat in formats.items():
249 |             self.set(col, pat)
250 | 
251 |     def get(self, col):
252 |         """Get format pattern (or None) for a specific column.
253 | 
254 |         Args:
255 |             col (int): Column index (1-indexed)
256 | 
257 |         Returns:
258 |             str: Format pattern or None
259 |         """
260 |         return self.formats.get(col)
261 | 
262 |     def set(self, col, pat):
263 |         """Set format pattern for column.
264 | 
265 |         Args:
266 |             col (int): Column index (1-indexed)
267 |             pat (str): Format pattern
268 |         """
269 |         if not pat:
270 |             return
271 | 
272 |         self.formats[col] = pat
273 | 
274 |     def format(self, col, cell):
275 |         """Format a value with the pattern set for column.
276 | 
277 |         If no format pattern is set for column, value is returned
278 |         unchanged.
279 | 
280 |         Args:
281 |             col (int): Column number
282 |             cell (xlrd.sheet.Cell): Excel cell
283 | 
284 |         Returns:
285 |             str: Formatted value
286 | 
287 |         """
288 |         pat = self.get(col)
289 |         log('col=%r, pat=%r, cell=%r', col, pat, cell)
290 |         if not pat or cell.ctype in (TYPE_BOOLEAN, TYPE_ERROR, TYPE_EMPTY):
291 |             return self._format_default(cell)
292 | 
293 |         if cell.ctype == TYPE_DATE:
294 |             dt = xldate_as_datetime(cell.value, self.datemode)
295 |             formatted = dt.strftime(pat)
296 | 
297 |         else:
298 |             try:
299 |                 formatted = pat % cell.value
300 |             except Exception:  # Try new-style formatting
301 |                 try:
302 |                     formatted = pat.format(cell.value)
303 |                 except Exception:
304 |                     formatted = cell.value
305 | 
306 |         # log('pat=%r, %r  -->  %r', pat, cell.value, formatted)
307 |         return formatted
308 | 
309 |     def _format_default(self, cell):
310 |         """Return cell value with default formatting.
311 | 
312 |         Args:
313 |             cell (xlrd.sheet.Cell): Excel cell
314 | 
315 |         Returns:
316 |             str: Formatted cell value
317 | 
318 |         """
319 |         if cell.ctype == TYPE_BOOLEAN:
320 |             if cell.value:
321 |                 return 'yes'
322 |             else:
323 |                 return 'no'
324 | 
325 |         if cell.ctype == TYPE_ERROR:
326 |             return '<error>'
327 | 
328 |         if cell.ctype == TYPE_EMPTY:
329 |             return ''
330 | 
331 |         if cell.ctype == TYPE_DATE:
332 |             dt = xldate_as_datetime(cell.value, self.datemode)
333 |             return dt.strftime(DATE_FORMAT)
334 | 
335 |         return cell.value
336 | 
337 | 
338 | def read_data(path, sheet, cols, start_row=1, variables=None,
339 |               formats=None, match=None):
340 |     """Read the specified cells from an Excel file.
341 | 
342 |     Args:
343 |         path (unicode): Path of XLSX file to read data from.
344 |         sheet (unicode): Number or name of sheet to read data from.
345 |         cols (list): The three columns to read title, subtitle and
346 |             value from respectively.
347 |         start_row (int, optional): The row on which to start reading data.
348 |         variables (dict, optional): name->col mapping of columns to read
349 |             into result variables with the corresponding names.
350 |         formats (dict, optional): index->format mapping of sprintf-style
351 |             format strings for columns.
352 |         match (str, optional): ``sprintf``-style format string for match
353 |             field.
354 | 
355 |     Returns:
356 |         list: Sequence of Alfred 3 result dictionaries.
357 | 
358 |     Raises:
359 |         ConfigError: Raised if an argument is invalid, e.g. non-existent
360 |             sheet name.
361 |     """
362 |     from xlrd import open_workbook
363 | 
364 |     variables = variables or {}
365 | 
366 |     wb = open_workbook(path)
367 | 
368 |     if sheet.isdigit():
369 |         s = wb.sheets()[int(sheet) - 1]
370 |     else:  # Name
371 |         for s in wb.sheets():
372 |             if s.name == sheet:
373 |                 break
374 |         else:
375 |             raise ConfigError("Couldn't find sheet: {}".format(sheet))
376 | 
377 |     log('Opened worksheet "%s" of %s', s.name, tilde(path))
378 | 
379 |     start_row -= 1
380 |     fmt = Formatter(wb.datemode, formats)
381 |     # cols = [i - 1 for i in cols]
382 | 
383 |     items = []
384 |     invalid = 0
385 | 
386 |     i = start_row
387 | 
388 |     while i < s.nrows:
389 |         evars = {}
390 |         match_data = None
391 |         sub = arg = ''
392 |         cell = s.cell(i, cols[0] - 1)
393 |         tit = fmt.format(cols[0], cell)
394 |         log('[title] i=%d, cell=%r, value=%r', i, cell, tit)
395 |         if cols[1] > -1:
396 |             cell = s.cell(i, cols[1] - 1)
397 |             sub = fmt.format(cols[1], cell)
398 |             log('[subtitle] i=%d, cell=%r, value=%r', i, cell, sub)
399 |         if cols[2] > -1:
400 |             cell = s.cell(i, cols[2] - 1)
401 |             arg = fmt.format(cols[2], cell)
402 |             log('[value] i=%d, cell=%r, value=%r', i, cell, arg)
403 | 
404 |         for k, j in variables.items():
405 |             value = None
406 |             cell = s.cell(i, j - 1)
407 |             value = fmt.format(j, cell)
408 |             evars[k] = value
409 |             log('[var:%s] i=%d, cell=%r, type=%s, value=%r', k, i, cell,
410 |                 cell_type(cell), value)
411 | 
412 |         if match:
413 |             try:
414 |                 match_data = match % evars
415 |                 log('[match] match=%s, evars=%r, match_data=%s',
416 |                     match, evars, match_data)
417 |             except Exception as err:
418 |                 log('[match] error formatting "%s" with %r: %s',
419 |                     match, evars, err)
420 | 
421 |         i += 1
422 | 
423 |         log('formats=%r, cols=%r, tit=%r, sub=%r, arg=%r, match=%r', formats,
424 |             cols, tit, sub, arg, match_data)
425 | 
426 |         if not tit:  # Invalid
427 |             invalid += 1
428 |             continue
429 | 
430 |         items.append(make_item(tit, sub, arg, match=match_data, **evars))
431 | 
432 |     log('Read %d rows from worksheet "%s"', len(items), s.name)
433 | 
434 |     return items
435 | 


--------------------------------------------------------------------------------
/src/isyn:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/python
 2 | # encoding: utf-8
 3 | #
 4 | # Copyright (c) 2016 Dean Jackson <deanishe@deanishe.net>
 5 | #
 6 | # MIT Licence. See http://opensource.org/licenses/MIT
 7 | #
 8 | # Created on 2016-05-21
 9 | #
10 | 
11 | """CLI command for I Sheet You Not"""
12 | 
13 | from __future__ import print_function, unicode_literals, absolute_import
14 | 
15 | from isheetyounot.cli import main
16 | from isheetyounot.aw3 import rescue
17 | 
18 | if __name__ == '__main__':
19 |     rescue(main)
20 | 


--------------------------------------------------------------------------------
/src/xlrd/__init__.py:
--------------------------------------------------------------------------------
  1 | from os import path
  2 | 
  3 | from .info import __VERSION__
  4 | 
  5 | # <p>Copyright (c) 2005-2012 Stephen John Machin, Lingfo Pty Ltd</p>
  6 | # <p>This module is part of the xlrd package, which is released under a
  7 | # BSD-style licence.</p>
  8 | 
  9 | from . import licences
 10 | 
 11 | ##
 12 | # <p><b>A Python module for extracting data from MS Excel (TM) spreadsheet files.
 13 | # <br /><br />
 14 | # Version 0.7.4 -- April 2012
 15 | # </b></p>
 16 | #
 17 | # <h2>General information</h2>
 18 | #
 19 | # <h3>Acknowledgements</h3>
 20 | #
 21 | # <p>
 22 | # Development of this module would not have been possible without the document
 23 | # "OpenOffice.org's Documentation of the Microsoft Excel File Format"
 24 | # ("OOo docs" for short).
 25 | # The latest version is available from OpenOffice.org in
 26 | # <a href=http://sc.openoffice.org/excelfileformat.pdf> PDF format</a>
 27 | # and
 28 | # <a href=http://sc.openoffice.org/excelfileformat.odt> ODT format.</a>
 29 | # Small portions of the OOo docs are reproduced in this
 30 | # document. A study of the OOo docs is recommended for those who wish a
 31 | # deeper understanding of the Excel file layout than the xlrd docs can provide.
 32 | # </p>
 33 | #
 34 | # <p>Backporting to Python 2.1 was partially funded by
 35 | #   <a href=http://journyx.com/>
 36 | #       Journyx - provider of timesheet and project accounting solutions.
 37 | #   </a>
 38 | # </p>
 39 | #
 40 | # <p>Provision of formatting information in version 0.6.1 was funded by
 41 | #   <a href=http://www.simplistix.co.uk>
 42 | #       Simplistix Ltd.
 43 | #   </a>
 44 | # </p>
 45 | #
 46 | # <h3>Unicode</h3>
 47 | #
 48 | # <p>This module presents all text strings as Python unicode objects.
 49 | # From Excel 97 onwards, text in Excel spreadsheets has been stored as Unicode.
 50 | # Older files (Excel 95 and earlier) don't keep strings in Unicode;
 51 | # a CODEPAGE record provides a codepage number (for example, 1252) which is
 52 | # used by xlrd to derive the encoding (for same example: "cp1252") which is
 53 | # used to translate to Unicode.</p>
 54 | # <small>
 55 | # <p>If the CODEPAGE record is missing (possible if the file was created
 56 | # by third-party software), xlrd will assume that the encoding is ascii, and keep going.
 57 | # If the actual encoding is not ascii, a UnicodeDecodeError exception will be raised and
 58 | # you will need to determine the encoding yourself, and tell xlrd:
 59 | # <pre>
 60 | #     book = xlrd.open_workbook(..., encoding_override="cp1252")
 61 | # </pre></p>
 62 | # <p>If the CODEPAGE record exists but is wrong (for example, the codepage
 63 | # number is 1251, but the strings are actually encoded in koi8_r),
 64 | # it can be overridden using the same mechanism.
 65 | # The supplied runxlrd.py has a corresponding command-line argument, which
 66 | # may be used for experimentation:
 67 | # <pre>
 68 | #     runxlrd.py -e koi8_r 3rows myfile.xls
 69 | # </pre></p>
 70 | # <p>The first place to look for an encoding ("codec name") is
 71 | # <a href=http://docs.python.org/lib/standard-encodings.html>
 72 | # the Python documentation</a>.
 73 | # </p>
 74 | # </small>
 75 | #
 76 | # <h3>Dates in Excel spreadsheets</h3>
 77 | #
 78 | # <p>In reality, there are no such things. What you have are floating point
 79 | # numbers and pious hope.
 80 | # There are several problems with Excel dates:</p>
 81 | #
 82 | # <p>(1) Dates are not stored as a separate data type; they are stored as
 83 | # floating point numbers and you have to rely on
 84 | # (a) the "number format" applied to them in Excel and/or
 85 | # (b) knowing which cells are supposed to have dates in them.
 86 | # This module helps with (a) by inspecting the
 87 | # format that has been applied to each number cell;
 88 | # if it appears to be a date format, the cell
 89 | # is classified as a date rather than a number. Feedback on this feature,
 90 | # especially from non-English-speaking locales, would be appreciated.</p>
 91 | #
 92 | # <p>(2) Excel for Windows stores dates by default as the number of
 93 | # days (or fraction thereof) since 1899-12-31T00:00:00. Excel for
 94 | # Macintosh uses a default start date of 1904-01-01T00:00:00. The date
 95 | # system can be changed in Excel on a per-workbook basis (for example:
 96 | # Tools -> Options -> Calculation, tick the "1904 date system" box).
 97 | # This is of course a bad idea if there are already dates in the
 98 | # workbook. There is no good reason to change it even if there are no
 99 | # dates in the workbook. Which date system is in use is recorded in the
100 | # workbook. A workbook transported from Windows to Macintosh (or vice
101 | # versa) will work correctly with the host Excel. When using this
102 | # module's xldate_as_tuple function to convert numbers from a workbook,
103 | # you must use the datemode attribute of the Book object. If you guess,
104 | # or make a judgement depending on where you believe the workbook was
105 | # created, you run the risk of being 1462 days out of kilter.</p>
106 | #
107 | # <p>Reference:
108 | # http://support.microsoft.com/default.aspx?scid=KB;EN-US;q180162</p>
109 | #
110 | #
111 | # <p>(3) The Excel implementation of the Windows-default 1900-based date system works on the
112 | # incorrect premise that 1900 was a leap year. It interprets the number 60 as meaning 1900-02-29,
113 | # which is not a valid date. Consequently any number less than 61 is ambiguous. Example: is 59 the
114 | # result of 1900-02-28 entered directly, or is it 1900-03-01 minus 2 days? The OpenOffice.org Calc
115 | # program "corrects" the Microsoft problem; entering 1900-02-27 causes the number 59 to be stored.
116 | # Save as an XLS file, then open the file with Excel -- you'll see 1900-02-28 displayed.</p>
117 | #
118 | # <p>Reference: http://support.microsoft.com/default.aspx?scid=kb;en-us;214326</p>
119 | #
120 | # <p>(4) The Macintosh-default 1904-based date system counts 1904-01-02 as day 1 and 1904-01-01 as day zero.
121 | # Thus any number such that (0.0 <= number < 1.0) is ambiguous. Is 0.625 a time of day (15:00:00),
122 | # independent of the calendar,
123 | # or should it be interpreted as an instant on a particular day (1904-01-01T15:00:00)?
124 | # The xldate_* functions in this module
125 | # take the view that such a number is a calendar-independent time of day (like Python's datetime.time type) for both
126 | # date systems. This is consistent with more recent Microsoft documentation
127 | # (for example, the help file for Excel 2002 which says that the first day
128 | # in the 1904 date system is 1904-01-02).
129 | #
130 | # <p>(5) Usage of the Excel DATE() function may leave strange dates in a spreadsheet. Quoting the help file,
131 | # in respect of the 1900 date system: "If year is between 0 (zero) and 1899 (inclusive),
132 | # Excel adds that value to 1900 to calculate the year. For example, DATE(108,1,2) returns January 2, 2008 (1900+108)."
133 | # This gimmick, semi-defensible only for arguments up to 99 and only in the pre-Y2K-awareness era,
134 | # means that DATE(1899, 12, 31) is interpreted as 3799-12-31.</p>
135 | #
136 | # <p>For further information, please refer to the documentation for the xldate_* functions.</p>
137 | #
138 | # <h3> Named references, constants, formulas, and macros</h3>
139 | #
140 | # <p>
141 | # A name is used to refer to a cell, a group of cells, a constant
142 | # value, a formula, or a macro. Usually the scope of a name is global
143 | # across the whole workbook. However it can be local to a worksheet.
144 | # For example, if the sales figures are in different cells in
145 | # different sheets, the user may define the name "Sales" in each
146 | # sheet. There are built-in names, like "Print_Area" and
147 | # "Print_Titles"; these two are naturally local to a sheet.
148 | # </p><p>
149 | # To inspect the names with a user interface like MS Excel, OOo Calc,
150 | # or Gnumeric, click on Insert/Names/Define. This will show the global
151 | # names, plus those local to the currently selected sheet.
152 | # </p><p>
153 | # A Book object provides two dictionaries (name_map and
154 | # name_and_scope_map) and a list (name_obj_list) which allow various
155 | # ways of accessing the Name objects. There is one Name object for
156 | # each NAME record found in the workbook. Name objects have many
157 | # attributes, several of which are relevant only when obj.macro is 1.
158 | # </p><p>
159 | # In the examples directory you will find namesdemo.xls which
160 | # showcases the many different ways that names can be used, and
161 | # xlrdnamesAPIdemo.py which offers 3 different queries for inspecting
162 | # the names in your files, and shows how to extract whatever a name is
163 | # referring to. There is currently one "convenience method",
164 | # Name.cell(), which extracts the value in the case where the name
165 | # refers to a single cell. More convenience methods are planned. The
166 | # source code for Name.cell (in __init__.py) is an extra source of
167 | # information on how the Name attributes hang together.
168 | # </p>
169 | #
170 | # <p><i>Name information is <b>not</b> extracted from files older than
171 | # Excel 5.0 (Book.biff_version < 50)</i></p>
172 | #
173 | # <h3>Formatting</h3>
174 | #
175 | # <h4>Introduction</h4>
176 | #
177 | # <p>This collection of features, new in xlrd version 0.6.1, is intended
178 | # to provide the information needed to (1) display/render spreadsheet contents
179 | # (say) on a screen or in a PDF file, and (2) copy spreadsheet data to another
180 | # file without losing the ability to display/render it.</p>
181 | #
182 | # <h4>The Palette; Colour Indexes</h4>
183 | #
184 | # <p>A colour is represented in Excel as a (red, green, blue) ("RGB") tuple
185 | # with each component in range(256). However it is not possible to access an
186 | # unlimited number of colours; each spreadsheet is limited to a palette of 64 different
187 | # colours (24 in Excel 3.0 and 4.0, 8 in Excel 2.0). Colours are referenced by an index
188 | # ("colour index") into this palette.
189 | #
190 | # Colour indexes 0 to 7 represent 8 fixed built-in colours: black, white, red, green, blue,
191 | # yellow, magenta, and cyan.<p>
192 | #
193 | # The remaining colours in the palette (8 to 63 in Excel 5.0 and later)
194 | # can be changed by the user. In the Excel 2003 UI, Tools/Options/Color presents a palette
195 | # of 7 rows of 8 colours. The last two rows are reserved for use in charts.<br />
196 | # The correspondence between this grid and the assigned
197 | # colour indexes is NOT left-to-right top-to-bottom.<br />
198 | # Indexes 8 to 15 correspond to changeable
199 | # parallels of the 8 fixed colours -- for example, index 7 is forever cyan;
200 | # index 15 starts off being cyan but can be changed by the user.<br />
201 | #
202 | # The default colour for each index depends on the file version; tables of the defaults
203 | # are available in the source code. If the user changes one or more colours,
204 | # a PALETTE record appears in the XLS file -- it gives the RGB values for *all* changeable
205 | # indexes.<br />
206 | # Note that colours can be used in "number formats": "[CYAN]...." and "[COLOR8]...." refer
207 | # to colour index 7; "[COLOR16]...." will produce cyan
208 | # unless the user changes colour index 15 to something else.<br />
209 | #
210 | # <p>In addition, there are several "magic" colour indexes used by Excel:<br />
211 | # 0x18 (BIFF3-BIFF4), 0x40 (BIFF5-BIFF8): System window text colour for border lines
212 | # (used in XF, CF, and WINDOW2 records)<br />
213 | # 0x19 (BIFF3-BIFF4), 0x41 (BIFF5-BIFF8): System window background colour for pattern background
214 | # (used in XF and CF records )<br />
215 | # 0x43: System face colour (dialogue background colour)<br />
216 | # 0x4D: System window text colour for chart border lines<br />
217 | # 0x4E: System window background colour for chart areas<br />
218 | # 0x4F: Automatic colour for chart border lines (seems to be always Black)<br />
219 | # 0x50: System ToolTip background colour (used in note objects)<br />
220 | # 0x51: System ToolTip text colour (used in note objects)<br />
221 | # 0x7FFF: System window text colour for fonts (used in FONT and CF records)<br />
222 | # Note 0x7FFF appears to be the *default* colour index. It appears quite often in FONT
223 | # records.<br />
224 | #
225 | # <h4>Default Formatting</h4>
226 | #
227 | # Default formatting is applied to all empty cells (those not described by a cell record).
228 | # Firstly row default information (ROW record, Rowinfo class) is used if available.
229 | # Failing that, column default information (COLINFO record, Colinfo class) is used if available.
230 | # As a last resort the worksheet/workbook default cell format will be used; this
231 | # should always be present in an Excel file,
232 | # described by the XF record with the fixed index 15 (0-based). By default, it uses the
233 | # worksheet/workbook default cell style, described by the very first XF record (index 0).
234 | #
235 | # <h4> Formatting features not included in xlrd version 0.6.1</h4>
236 | # <ul>
237 | #   <li>Rich text i.e. strings containing partial <b>bold</b> <i>italic</i>
238 | #       and <u>underlined</u> text, change of font inside a string, etc.
239 | #       See OOo docs s3.4 and s3.2.
240 | #       <i> Rich text is included in version 0.7.2</i></li>
241 | #   <li>Asian phonetic text (known as "ruby"), used for Japanese furigana. See OOo docs
242 | #       s3.4.2 (p15)</li>
243 | #   <li>Conditional formatting. See OOo docs
244 | #       s5.12, s6.21 (CONDFMT record), s6.16 (CF record)</li>
245 | #   <li>Miscellaneous sheet-level and book-level items e.g. printing layout, screen panes. </li>
246 | #   <li>Modern Excel file versions don't keep most of the built-in
247 | #       "number formats" in the file; Excel loads formats according to the
248 | #       user's locale. Currently xlrd's emulation of this is limited to
249 | #       a hard-wired table that applies to the US English locale. This may mean
250 | #       that currency symbols, date order, thousands separator, decimals separator, etc
251 | #       are inappropriate. Note that this does not affect users who are copying XLS
252 | #       files, only those who are visually rendering cells.</li>
253 | # </ul>
254 | #
255 | # <h3>Loading worksheets on demand</h3>
256 | #
257 | # <p>This feature, new in version 0.7.1, is governed by the on_demand argument
258 | # to the open_workbook() function and allows saving memory and time by loading
259 | # only those sheets that the caller is interested in, and releasing sheets
260 | # when no longer required.</p>
261 | #
262 | # <p>on_demand=False (default): No change. open_workbook() loads global data
263 | # and all sheets, releases resources no longer required (principally the
264 | # str or mmap object containing the Workbook stream), and returns.</p>
265 | #
266 | # <p>on_demand=True and BIFF version < 5.0: A warning message is emitted,
267 | # on_demand is recorded as False, and the old process is followed.</p>
268 | #
269 | # <p>on_demand=True and BIFF version >= 5.0: open_workbook() loads global
270 | # data and returns without releasing resources. At this stage, the only
271 | # information available about sheets is Book.nsheets and Book.sheet_names().</p>
272 | #
273 | # <p>Book.sheet_by_name() and Book.sheet_by_index() will load the requested
274 | # sheet if it is not already loaded.</p>
275 | #
276 | # <p>Book.sheets() will load all/any unloaded sheets.</p>
277 | #
278 | # <p>The caller may save memory by calling
279 | # Book.unload_sheet(sheet_name_or_index) when finished with the sheet.
280 | # This applies irrespective of the state of on_demand.</p>
281 | #
282 | # <p>The caller may re-load an unloaded sheet by calling Book.sheet_by_xxxx()
283 | #  -- except if those required resources have been released (which will
284 | # have happened automatically when on_demand is false). This is the only
285 | # case where an exception will be raised.</p>
286 | #
287 | # <p>The caller may query the state of a sheet:
288 | # Book.sheet_loaded(sheet_name_or_index) -> a bool</p>
289 | #
290 | # <p> Book.release_resources() may used to save memory and close
291 | # any memory-mapped file before proceding to examine already-loaded
292 | # sheets. Once resources are released, no further sheets can be loaded.</p>
293 | #
294 | # <p> When using on-demand, it is advisable to ensure that
295 | # Book.release_resources() is always called even if an exception
296 | # is raised in your own code; otherwise if the input file has been
297 | # memory-mapped, the mmap.mmap object will not be closed and you will
298 | # not be able to access the physical file until your Python process
299 | # terminates. This can be done by calling Book.release_resources()
300 | # explicitly in the finally suite of a try/finally block.
301 | # New in xlrd 0.7.2: the Book object is a "context manager", so if
302 | # using Python 2.5 or later, you can wrap your code in a "with"
303 | # statement.</p>
304 | ##
305 | 
306 | import sys, zipfile, pprint
307 | from . import timemachine
308 | from .biffh import (
309 |     XLRDError,
310 |     biff_text_from_num,
311 |     error_text_from_code,
312 |     XL_CELL_BLANK,
313 |     XL_CELL_TEXT,
314 |     XL_CELL_BOOLEAN,
315 |     XL_CELL_ERROR,
316 |     XL_CELL_EMPTY,
317 |     XL_CELL_DATE,
318 |     XL_CELL_NUMBER
319 |     )
320 | from .formula import * # is constrained by __all__
321 | from .book import Book, colname #### TODO #### formula also has `colname` (restricted to 256 cols)
322 | from .sheet import empty_cell
323 | from .xldate import XLDateError, xldate_as_tuple
324 | 
325 | if sys.version.startswith("IronPython"):
326 |     # print >> sys.stderr, "...importing encodings"
327 |     import encodings
328 | 
329 | try:
330 |     import mmap
331 |     MMAP_AVAILABLE = 1
332 | except ImportError:
333 |     MMAP_AVAILABLE = 0
334 | USE_MMAP = MMAP_AVAILABLE
335 | 
336 | ##
337 | #
338 | # Open a spreadsheet file for data extraction.
339 | #
340 | # @param filename The path to the spreadsheet file to be opened.
341 | #
342 | # @param logfile An open file to which messages and diagnostics are written.
343 | #
344 | # @param verbosity Increases the volume of trace material written to the logfile.
345 | #
346 | # @param use_mmap Whether to use the mmap module is determined heuristically.
347 | # Use this arg to override the result. Current heuristic: mmap is used if it exists.
348 | #
349 | # @param file_contents ... as a string or an mmap.mmap object or some other behave-alike object.
350 | # If file_contents is supplied, filename will not be used, except (possibly) in messages.
351 | #
352 | # @param encoding_override Used to overcome missing or bad codepage information
353 | # in older-version files. Refer to discussion in the <b>Unicode</b> section above.
354 | # <br /> -- New in version 0.6.0
355 | #
356 | # @param formatting_info Governs provision of a reference to an XF (eXtended Format) object
357 | # for each cell in the worksheet.
358 | # <br /> Default is <i>False</i>. This is backwards compatible and saves memory.
359 | # "Blank" cells (those with their own formatting information but no data) are treated as empty
360 | # (by ignoring the file's BLANK and MULBLANK records).
361 | # It cuts off any bottom "margin" of rows of empty (and blank) cells and
362 | # any right "margin" of columns of empty (and blank) cells.
363 | # Only cell_value and cell_type are available.
364 | # <br /> <i>True</i> provides all cells, including empty and blank cells.
365 | # XF information is available for each cell.
366 | # <br /> -- New in version 0.6.1
367 | #
368 | # @param on_demand Governs whether sheets are all loaded initially or when demanded
369 | # by the caller. Please refer back to the section "Loading worksheets on demand" for details.
370 | # <br /> -- New in version 0.7.1
371 | #
372 | # @param ragged_rows False (the default) means all rows are padded out with empty cells so that all
373 | # rows have the same size (Sheet.ncols). True means that there are no empty cells at the ends of rows.
374 | # This can result in substantial memory savings if rows are of widely varying sizes. See also the
375 | # Sheet.row_len() method.
376 | # <br /> -- New in version 0.7.2
377 | #
378 | # @return An instance of the Book class.
379 | 
380 | def open_workbook(filename=None,
381 |     logfile=sys.stdout,
382 |     verbosity=0,
383 |     use_mmap=USE_MMAP,
384 |     file_contents=None,
385 |     encoding_override=None,
386 |     formatting_info=False,
387 |     on_demand=False,
388 |     ragged_rows=False,
389 |     ):
390 |     peeksz = 4
391 |     if file_contents:
392 |         peek = file_contents[:peeksz]
393 |     else:
394 |         f = open(filename, "rb")
395 |         peek = f.read(peeksz)
396 |         f.close()
397 |     if peek == b"PK\x03\x04": # a ZIP file
398 |         if file_contents:
399 |             zf = zipfile.ZipFile(timemachine.BYTES_IO(file_contents))
400 |         else:
401 |             zf = zipfile.ZipFile(filename)
402 | 
403 |         # Workaround for some third party files that use forward slashes and
404 |         # lower case names. We map the expected name in lowercase to the
405 |         # actual filename in the zip container.
406 |         component_names = dict([(name.replace('\\', '/').lower(), name)
407 |                                 for name in zf.namelist()])
408 | 
409 |         if verbosity:
410 |             logfile.write('ZIP component_names:\n')
411 |             pprint.pprint(component_names, logfile)
412 |         if 'xl/workbook.xml' in component_names:
413 |             from . import xlsx
414 |             bk = xlsx.open_workbook_2007_xml(
415 |                 zf,
416 |                 component_names,
417 |                 logfile=logfile,
418 |                 verbosity=verbosity,
419 |                 use_mmap=use_mmap,
420 |                 formatting_info=formatting_info,
421 |                 on_demand=on_demand,
422 |                 ragged_rows=ragged_rows,
423 |                 )
424 |             return bk
425 |         if 'xl/workbook.bin' in component_names:
426 |             raise XLRDError('Excel 2007 xlsb file; not supported')
427 |         if 'content.xml' in component_names:
428 |             raise XLRDError('Openoffice.org ODS file; not supported')
429 |         raise XLRDError('ZIP file contents not a known type of workbook')
430 | 
431 |     from . import book
432 |     bk = book.open_workbook_xls(
433 |         filename=filename,
434 |         logfile=logfile,
435 |         verbosity=verbosity,
436 |         use_mmap=use_mmap,
437 |         file_contents=file_contents,
438 |         encoding_override=encoding_override,
439 |         formatting_info=formatting_info,
440 |         on_demand=on_demand,
441 |         ragged_rows=ragged_rows,
442 |         )
443 |     return bk
444 | 
445 | ##
446 | # For debugging: dump an XLS file's BIFF records in char & hex.
447 | # @param filename The path to the file to be dumped.
448 | # @param outfile An open file, to which the dump is written.
449 | # @param unnumbered If true, omit offsets (for meaningful diffs).
450 | 
451 | def dump(filename, outfile=sys.stdout, unnumbered=False):
452 |     from .biffh import biff_dump
453 |     bk = Book()
454 |     bk.biff2_8_load(filename=filename, logfile=outfile, )
455 |     biff_dump(bk.mem, bk.base, bk.stream_len, 0, outfile, unnumbered)
456 | 
457 | ##
458 | # For debugging and analysis: summarise the file's BIFF records.
459 | # I.e. produce a sorted file of (record_name, count).
460 | # @param filename The path to the file to be summarised.
461 | # @param outfile An open file, to which the summary is written.
462 | 
463 | def count_records(filename, outfile=sys.stdout):
464 |     from .biffh import biff_count_records
465 |     bk = Book()
466 |     bk.biff2_8_load(filename=filename, logfile=outfile, )
467 |     biff_count_records(bk.mem, bk.base, bk.stream_len, outfile)
468 | 


--------------------------------------------------------------------------------
/src/xlrd/biffh.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/biffh.py


--------------------------------------------------------------------------------
/src/xlrd/compdoc.py:
--------------------------------------------------------------------------------
  1 | # -*- coding: cp1252 -*-
  2 | 
  3 | ##
  4 | # Implements the minimal functionality required
  5 | # to extract a "Workbook" or "Book" stream (as one big string)
  6 | # from an OLE2 Compound Document file.
  7 | # <p>Copyright � 2005-2012 Stephen John Machin, Lingfo Pty Ltd</p>
  8 | # <p>This module is part of the xlrd package, which is released under a BSD-style licence.</p>
  9 | ##
 10 | 
 11 | # No part of the content of this file was derived from the works of David Giffin.
 12 | 
 13 | # 2008-11-04 SJM Avoid assertion error when -1 used instead of -2 for first_SID of empty SCSS [Frank Hoffsuemmer]
 14 | # 2007-09-08 SJM Warning message if sector sizes are extremely large.
 15 | # 2007-05-07 SJM Meaningful exception instead of IndexError if a SAT (sector allocation table) is corrupted.
 16 | # 2007-04-22 SJM Missing "<" in a struct.unpack call => can't open files on bigendian platforms.
 17 | 
 18 | from __future__ import print_function
 19 | import sys
 20 | from struct import unpack
 21 | from .timemachine import *
 22 | import array
 23 | 
 24 | ##
 25 | # Magic cookie that should appear in the first 8 bytes of the file.
 26 | SIGNATURE = b"\xD0\xCF\x11\xE0\xA1\xB1\x1A\xE1"
 27 | 
 28 | EOCSID = -2
 29 | FREESID = -1
 30 | SATSID = -3
 31 | MSATSID = -4
 32 | EVILSID = -5
 33 | 
 34 | class CompDocError(Exception):
 35 |     pass
 36 | 
 37 | class DirNode(object):
 38 | 
 39 |     def __init__(self, DID, dent, DEBUG=0, logfile=sys.stdout):
 40 |         # dent is the 128-byte directory entry
 41 |         self.DID = DID
 42 |         self.logfile = logfile
 43 |         (cbufsize, self.etype, self.colour, self.left_DID, self.right_DID,
 44 |         self.root_DID) = \
 45 |             unpack('<HBBiii', dent[64:80])
 46 |         (self.first_SID, self.tot_size) = \
 47 |             unpack('<ii', dent[116:124])
 48 |         if cbufsize == 0:
 49 |             self.name = UNICODE_LITERAL('')
 50 |         else:
 51 |             self.name = unicode(dent[0:cbufsize-2], 'utf_16_le') # omit the trailing U+0000
 52 |         self.children = [] # filled in later
 53 |         self.parent = -1 # indicates orphan; fixed up later
 54 |         self.tsinfo = unpack('<IIII', dent[100:116])
 55 |         if DEBUG:
 56 |             self.dump(DEBUG)
 57 | 
 58 |     def dump(self, DEBUG=1):
 59 |         fprintf(
 60 |             self.logfile,
 61 |             "DID=%d name=%r etype=%d DIDs(left=%d right=%d root=%d parent=%d kids=%r) first_SID=%d tot_size=%d\n",
 62 |             self.DID, self.name, self.etype, self.left_DID,
 63 |             self.right_DID, self.root_DID, self.parent, self.children, self.first_SID, self.tot_size
 64 |             )
 65 |         if DEBUG == 2:
 66 |             # cre_lo, cre_hi, mod_lo, mod_hi = tsinfo
 67 |             print("timestamp info", self.tsinfo, file=self.logfile)
 68 | 
 69 | def _build_family_tree(dirlist, parent_DID, child_DID):
 70 |     if child_DID < 0: return
 71 |     _build_family_tree(dirlist, parent_DID, dirlist[child_DID].left_DID)
 72 |     dirlist[parent_DID].children.append(child_DID)
 73 |     dirlist[child_DID].parent = parent_DID
 74 |     _build_family_tree(dirlist, parent_DID, dirlist[child_DID].right_DID)
 75 |     if dirlist[child_DID].etype == 1: # storage
 76 |         _build_family_tree(dirlist, child_DID, dirlist[child_DID].root_DID)
 77 | 
 78 | ##
 79 | # Compound document handler.
 80 | # @param mem The raw contents of the file, as a string, or as an mmap.mmap() object. The
 81 | # only operation it needs to support is slicing.
 82 | 
 83 | class CompDoc(object):
 84 | 
 85 |     def __init__(self, mem, logfile=sys.stdout, DEBUG=0):
 86 |         self.logfile = logfile
 87 |         self.DEBUG = DEBUG
 88 |         if mem[0:8] != SIGNATURE:
 89 |             raise CompDocError('Not an OLE2 compound document')
 90 |         if mem[28:30] != b'\xFE\xFF':
 91 |             raise CompDocError('Expected "little-endian" marker, found %r' % mem[28:30])
 92 |         revision, version = unpack('<HH', mem[24:28])
 93 |         if DEBUG:
 94 |             print("\nCompDoc format: version=0x%04x revision=0x%04x" % (version, revision), file=logfile)
 95 |         self.mem = mem
 96 |         ssz, sssz = unpack('<HH', mem[30:34])
 97 |         if ssz > 20: # allows for 2**20 bytes i.e. 1MB
 98 |             print("WARNING: sector size (2**%d) is preposterous; assuming 512 and continuing ..." \
 99 |                 % ssz, file=logfile)
100 |             ssz = 9
101 |         if sssz > ssz:
102 |             print("WARNING: short stream sector size (2**%d) is preposterous; assuming 64 and continuing ..." \
103 |                 % sssz, file=logfile)
104 |             sssz = 6
105 |         self.sec_size = sec_size = 1 << ssz
106 |         self.short_sec_size = 1 << sssz
107 |         if self.sec_size != 512 or self.short_sec_size != 64:
108 |             print("@@@@ sec_size=%d short_sec_size=%d" % (self.sec_size, self.short_sec_size), file=logfile)
109 |         (
110 |             SAT_tot_secs, self.dir_first_sec_sid, _unused, self.min_size_std_stream,
111 |             SSAT_first_sec_sid, SSAT_tot_secs,
112 |             MSATX_first_sec_sid, MSATX_tot_secs,
113 |         # ) = unpack('<ii4xiiiii', mem[44:76])
114 |         ) = unpack('<iiiiiiii', mem[44:76])
115 |         mem_data_len = len(mem) - 512
116 |         mem_data_secs, left_over = divmod(mem_data_len, sec_size)
117 |         if left_over:
118 |             #### raise CompDocError("Not a whole number of sectors")
119 |             mem_data_secs += 1
120 |             print("WARNING *** file size (%d) not 512 + multiple of sector size (%d)" \
121 |                 % (len(mem), sec_size), file=logfile)
122 |         self.mem_data_secs = mem_data_secs # use for checking later
123 |         self.mem_data_len = mem_data_len
124 |         seen = self.seen = array.array('B', [0]) * mem_data_secs
125 | 
126 |         if DEBUG:
127 |             print('sec sizes', ssz, sssz, sec_size, self.short_sec_size, file=logfile)
128 |             print("mem data: %d bytes == %d sectors" % (mem_data_len, mem_data_secs), file=logfile)
129 |             print("SAT_tot_secs=%d, dir_first_sec_sid=%d, min_size_std_stream=%d" \
130 |                 % (SAT_tot_secs, self.dir_first_sec_sid, self.min_size_std_stream,), file=logfile)
131 |             print("SSAT_first_sec_sid=%d, SSAT_tot_secs=%d" % (SSAT_first_sec_sid, SSAT_tot_secs,), file=logfile)
132 |             print("MSATX_first_sec_sid=%d, MSATX_tot_secs=%d" % (MSATX_first_sec_sid, MSATX_tot_secs,), file=logfile)
133 |         nent = sec_size // 4 # number of SID entries in a sector
134 |         fmt = "<%di" % nent
135 |         trunc_warned = 0
136 |         #
137 |         # === build the MSAT ===
138 |         #
139 |         MSAT = list(unpack('<109i', mem[76:512]))
140 |         SAT_sectors_reqd = (mem_data_secs + nent - 1) // nent
141 |         expected_MSATX_sectors = max(0, (SAT_sectors_reqd - 109 + nent - 2) // (nent - 1))
142 |         actual_MSATX_sectors = 0
143 |         if MSATX_tot_secs == 0 and MSATX_first_sec_sid in (EOCSID, FREESID, 0):
144 |             # Strictly, if there is no MSAT extension, then MSATX_first_sec_sid
145 |             # should be set to EOCSID ... FREESID and 0 have been met in the wild.
146 |             pass # Presuming no extension
147 |         else:
148 |             sid = MSATX_first_sec_sid
149 |             while sid not in (EOCSID, FREESID):
150 |                 # Above should be only EOCSID according to MS & OOo docs
151 |                 # but Excel doesn't complain about FREESID. Zero is a valid
152 |                 # sector number, not a sentinel.
153 |                 if DEBUG > 1:
154 |                     print('MSATX: sid=%d (0x%08X)' % (sid, sid), file=logfile)
155 |                 if sid >= mem_data_secs:
156 |                     msg = "MSAT extension: accessing sector %d but only %d in file" % (sid, mem_data_secs)
157 |                     if DEBUG > 1:
158 |                         print(msg, file=logfile)
159 |                         break
160 |                     raise CompDocError(msg)
161 |                 elif sid < 0:
162 |                     raise CompDocError("MSAT extension: invalid sector id: %d" % sid)
163 |                 if seen[sid]:
164 |                     raise CompDocError("MSAT corruption: seen[%d] == %d" % (sid, seen[sid]))
165 |                 seen[sid] = 1
166 |                 actual_MSATX_sectors += 1
167 |                 if DEBUG and actual_MSATX_sectors > expected_MSATX_sectors:
168 |                     print("[1]===>>>", mem_data_secs, nent, SAT_sectors_reqd, expected_MSATX_sectors, actual_MSATX_sectors, file=logfile)
169 |                 offset = 512 + sec_size * sid
170 |                 MSAT.extend(unpack(fmt, mem[offset:offset+sec_size]))
171 |                 sid = MSAT.pop() # last sector id is sid of next sector in the chain
172 |                 
173 |         if DEBUG and actual_MSATX_sectors != expected_MSATX_sectors:
174 |             print("[2]===>>>", mem_data_secs, nent, SAT_sectors_reqd, expected_MSATX_sectors, actual_MSATX_sectors, file=logfile)
175 |         if DEBUG:
176 |             print("MSAT: len =", len(MSAT), file=logfile)
177 |             dump_list(MSAT, 10, logfile)
178 |         #
179 |         # === build the SAT ===
180 |         #
181 |         self.SAT = []
182 |         actual_SAT_sectors = 0
183 |         dump_again = 0
184 |         for msidx in xrange(len(MSAT)):
185 |             msid = MSAT[msidx]
186 |             if msid in (FREESID, EOCSID):
187 |                 # Specification: the MSAT array may be padded with trailing FREESID entries.
188 |                 # Toleration: a FREESID or EOCSID entry anywhere in the MSAT array will be ignored.
189 |                 continue
190 |             if msid >= mem_data_secs:
191 |                 if not trunc_warned:
192 |                     print("WARNING *** File is truncated, or OLE2 MSAT is corrupt!!", file=logfile)
193 |                     print("INFO: Trying to access sector %d but only %d available" \
194 |                         % (msid, mem_data_secs), file=logfile)
195 |                     trunc_warned = 1
196 |                 MSAT[msidx] = EVILSID
197 |                 dump_again = 1
198 |                 continue
199 |             elif msid < -2:
200 |                 raise CompDocError("MSAT: invalid sector id: %d" % msid)
201 |             if seen[msid]:
202 |                 raise CompDocError("MSAT extension corruption: seen[%d] == %d" % (msid, seen[msid]))
203 |             seen[msid] = 2
204 |             actual_SAT_sectors += 1
205 |             if DEBUG and actual_SAT_sectors > SAT_sectors_reqd:
206 |                 print("[3]===>>>", mem_data_secs, nent, SAT_sectors_reqd, expected_MSATX_sectors, actual_MSATX_sectors, actual_SAT_sectors, msid, file=logfile)
207 |             offset = 512 + sec_size * msid
208 |             self.SAT.extend(unpack(fmt, mem[offset:offset+sec_size]))
209 | 
210 |         if DEBUG:
211 |             print("SAT: len =", len(self.SAT), file=logfile)
212 |             dump_list(self.SAT, 10, logfile)
213 |             # print >> logfile, "SAT ",
214 |             # for i, s in enumerate(self.SAT):
215 |                 # print >> logfile, "entry: %4d offset: %6d, next entry: %4d" % (i, 512 + sec_size * i, s)
216 |                 # print >> logfile, "%d:%d " % (i, s),
217 |             print(file=logfile)
218 |         if DEBUG and dump_again:
219 |             print("MSAT: len =", len(MSAT), file=logfile)
220 |             dump_list(MSAT, 10, logfile)
221 |             for satx in xrange(mem_data_secs, len(self.SAT)):
222 |                 self.SAT[satx] = EVILSID
223 |             print("SAT: len =", len(self.SAT), file=logfile)
224 |             dump_list(self.SAT, 10, logfile)
225 |         #
226 |         # === build the directory ===
227 |         #
228 |         dbytes = self._get_stream(
229 |             self.mem, 512, self.SAT, self.sec_size, self.dir_first_sec_sid,
230 |             name="directory", seen_id=3)
231 |         dirlist = []
232 |         did = -1
233 |         for pos in xrange(0, len(dbytes), 128):
234 |             did += 1
235 |             dirlist.append(DirNode(did, dbytes[pos:pos+128], 0, logfile))
236 |         self.dirlist = dirlist
237 |         _build_family_tree(dirlist, 0, dirlist[0].root_DID) # and stand well back ...
238 |         if DEBUG:
239 |             for d in dirlist:
240 |                 d.dump(DEBUG)
241 |         #
242 |         # === get the SSCS ===
243 |         #
244 |         sscs_dir = self.dirlist[0]
245 |         assert sscs_dir.etype == 5 # root entry
246 |         if sscs_dir.first_SID < 0 or sscs_dir.tot_size == 0:
247 |             # Problem reported by Frank Hoffsuemmer: some software was
248 |             # writing -1 instead of -2 (EOCSID) for the first_SID
249 |             # when the SCCS was empty. Not having EOCSID caused assertion
250 |             # failure in _get_stream.
251 |             # Solution: avoid calling _get_stream in any case when the
252 |             # SCSS appears to be empty.
253 |             self.SSCS = ""
254 |         else:
255 |             self.SSCS = self._get_stream(
256 |                 self.mem, 512, self.SAT, sec_size, sscs_dir.first_SID,
257 |                 sscs_dir.tot_size, name="SSCS", seen_id=4)
258 |         # if DEBUG: print >> logfile, "SSCS", repr(self.SSCS)
259 |         #
260 |         # === build the SSAT ===
261 |         #
262 |         self.SSAT = []
263 |         if SSAT_tot_secs > 0 and sscs_dir.tot_size == 0:
264 |             print("WARNING *** OLE2 inconsistency: SSCS size is 0 but SSAT size is non-zero", file=logfile)
265 |         if sscs_dir.tot_size > 0:
266 |             sid = SSAT_first_sec_sid
267 |             nsecs = SSAT_tot_secs
268 |             while sid >= 0 and nsecs > 0:
269 |                 if seen[sid]:
270 |                     raise CompDocError("SSAT corruption: seen[%d] == %d" % (sid, seen[sid]))
271 |                 seen[sid] = 5
272 |                 nsecs -= 1
273 |                 start_pos = 512 + sid * sec_size
274 |                 news = list(unpack(fmt, mem[start_pos:start_pos+sec_size]))
275 |                 self.SSAT.extend(news)
276 |                 sid = self.SAT[sid]
277 |             if DEBUG: print("SSAT last sid %d; remaining sectors %d" % (sid, nsecs), file=logfile)
278 |             assert nsecs == 0 and sid == EOCSID
279 |         if DEBUG:
280 |             print("SSAT", file=logfile)
281 |             dump_list(self.SSAT, 10, logfile)
282 |         if DEBUG:
283 |             print("seen", file=logfile)
284 |             dump_list(seen, 20, logfile)
285 | 
286 |     def _get_stream(self, mem, base, sat, sec_size, start_sid, size=None, name='', seen_id=None):
287 |         # print >> self.logfile, "_get_stream", base, sec_size, start_sid, size
288 |         sectors = []
289 |         s = start_sid
290 |         if size is None:
291 |             # nothing to check against
292 |             while s >= 0:
293 |                 if seen_id is not None:
294 |                     if self.seen[s]:
295 |                         raise CompDocError("%s corruption: seen[%d] == %d" % (name, s, self.seen[s]))
296 |                     self.seen[s] = seen_id
297 |                 start_pos = base + s * sec_size
298 |                 sectors.append(mem[start_pos:start_pos+sec_size])
299 |                 try:
300 |                     s = sat[s]
301 |                 except IndexError:
302 |                     raise CompDocError(
303 |                         "OLE2 stream %r: sector allocation table invalid entry (%d)" %
304 |                         (name, s)
305 |                         )
306 |             assert s == EOCSID
307 |         else:
308 |             todo = size
309 |             while s >= 0:
310 |                 if seen_id is not None:
311 |                     if self.seen[s]:
312 |                         raise CompDocError("%s corruption: seen[%d] == %d" % (name, s, self.seen[s]))
313 |                     self.seen[s] = seen_id
314 |                 start_pos = base + s * sec_size
315 |                 grab = sec_size
316 |                 if grab > todo:
317 |                     grab = todo
318 |                 todo -= grab
319 |                 sectors.append(mem[start_pos:start_pos+grab])
320 |                 try:
321 |                     s = sat[s]
322 |                 except IndexError:
323 |                     raise CompDocError(
324 |                         "OLE2 stream %r: sector allocation table invalid entry (%d)" %
325 |                         (name, s)
326 |                         )
327 |             assert s == EOCSID
328 |             if todo != 0:
329 |                 fprintf(self.logfile, 
330 |                     "WARNING *** OLE2 stream %r: expected size %d, actual size %d\n",
331 |                     name, size, size - todo)
332 | 
333 |         return b''.join(sectors)
334 | 
335 |     def _dir_search(self, path, storage_DID=0):
336 |         # Return matching DirNode instance, or None
337 |         head = path[0]
338 |         tail = path[1:]
339 |         dl = self.dirlist
340 |         for child in dl[storage_DID].children:
341 |             if dl[child].name.lower() == head.lower():
342 |                 et = dl[child].etype
343 |                 if et == 2:
344 |                     return dl[child]
345 |                 if et == 1:
346 |                     if not tail:
347 |                         raise CompDocError("Requested component is a 'storage'")
348 |                     return self._dir_search(tail, child)
349 |                 dl[child].dump(1)
350 |                 raise CompDocError("Requested stream is not a 'user stream'")
351 |         return None
352 | 
353 |     ##
354 |     # Interrogate the compound document's directory; return the stream as a string if found, otherwise
355 |     # return None.
356 |     # @param qname Name of the desired stream e.g. u'Workbook'. Should be in Unicode or convertible thereto.
357 | 
358 |     def get_named_stream(self, qname):
359 |         d = self._dir_search(qname.split("/"))
360 |         if d is None:
361 |             return None
362 |         if d.tot_size >= self.min_size_std_stream:
363 |             return self._get_stream(
364 |                 self.mem, 512, self.SAT, self.sec_size, d.first_SID,
365 |                 d.tot_size, name=qname, seen_id=d.DID+6)
366 |         else:
367 |             return self._get_stream(
368 |                 self.SSCS, 0, self.SSAT, self.short_sec_size, d.first_SID,
369 |                 d.tot_size, name=qname + " (from SSCS)", seen_id=None)
370 | 
371 |     ##
372 |     # Interrogate the compound document's directory.
373 |     # If the named stream is not found, (None, 0, 0) will be returned.
374 |     # If the named stream is found and is contiguous within the original byte sequence ("mem")
375 |     # used when the document was opened,
376 |     # then (mem, offset_to_start_of_stream, length_of_stream) is returned.
377 |     # Otherwise a new string is built from the fragments and (new_string, 0, length_of_stream) is returned.
378 |     # @param qname Name of the desired stream e.g. u'Workbook'. Should be in Unicode or convertible thereto.
379 | 
380 |     def locate_named_stream(self, qname):
381 |         d = self._dir_search(qname.split("/"))
382 |         if d is None:
383 |             return (None, 0, 0)
384 |         if d.tot_size > self.mem_data_len:
385 |             raise CompDocError("%r stream length (%d bytes) > file data size (%d bytes)"
386 |                 % (qname, d.tot_size, self.mem_data_len))
387 |         if d.tot_size >= self.min_size_std_stream:
388 |             result = self._locate_stream(
389 |                 self.mem, 512, self.SAT, self.sec_size, d.first_SID, 
390 |                 d.tot_size, qname, d.DID+6)
391 |             if self.DEBUG:
392 |                 print("\nseen", file=self.logfile)
393 |                 dump_list(self.seen, 20, self.logfile)
394 |             return result
395 |         else:
396 |             return (
397 |                 self._get_stream(
398 |                     self.SSCS, 0, self.SSAT, self.short_sec_size, d.first_SID,
399 |                     d.tot_size, qname + " (from SSCS)", None),
400 |                 0,
401 |                 d.tot_size
402 |                 )
403 | 
404 |     def _locate_stream(self, mem, base, sat, sec_size, start_sid, expected_stream_size, qname, seen_id):
405 |         # print >> self.logfile, "_locate_stream", base, sec_size, start_sid, expected_stream_size
406 |         s = start_sid
407 |         if s < 0:
408 |             raise CompDocError("_locate_stream: start_sid (%d) is -ve" % start_sid)
409 |         p = -99 # dummy previous SID
410 |         start_pos = -9999
411 |         end_pos = -8888
412 |         slices = []
413 |         tot_found = 0
414 |         found_limit = (expected_stream_size + sec_size - 1) // sec_size
415 |         while s >= 0:
416 |             if self.seen[s]:
417 |                 print("_locate_stream(%s): seen" % qname, file=self.logfile); dump_list(self.seen, 20, self.logfile)
418 |                 raise CompDocError("%s corruption: seen[%d] == %d" % (qname, s, self.seen[s]))
419 |             self.seen[s] = seen_id
420 |             tot_found += 1
421 |             if tot_found > found_limit:
422 |                 raise CompDocError(
423 |                     "%s: size exceeds expected %d bytes; corrupt?"
424 |                     % (qname, found_limit * sec_size)
425 |                     ) # Note: expected size rounded up to higher sector
426 |             if s == p+1:
427 |                 # contiguous sectors
428 |                 end_pos += sec_size
429 |             else:
430 |                 # start new slice
431 |                 if p >= 0:
432 |                     # not first time
433 |                     slices.append((start_pos, end_pos))
434 |                 start_pos = base + s * sec_size
435 |                 end_pos = start_pos + sec_size
436 |             p = s
437 |             s = sat[s]
438 |         assert s == EOCSID
439 |         assert tot_found == found_limit
440 |         # print >> self.logfile, "_locate_stream(%s): seen" % qname; dump_list(self.seen, 20, self.logfile)
441 |         if not slices:
442 |             # The stream is contiguous ... just what we like!
443 |             return (mem, start_pos, expected_stream_size)
444 |         slices.append((start_pos, end_pos))
445 |         # print >> self.logfile, "+++>>> %d fragments" % len(slices)
446 |         return (b''.join([mem[start_pos:end_pos] for start_pos, end_pos in slices]), 0, expected_stream_size)
447 | 
448 | # ==========================================================================================
449 | def x_dump_line(alist, stride, f, dpos, equal=0):
450 |     print("%5d%s" % (dpos, " ="[equal]), end=' ', file=f)
451 |     for value in alist[dpos:dpos + stride]:
452 |         print(str(value), end=' ', file=f)
453 |     print(file=f)
454 | 
455 | def dump_list(alist, stride, f=sys.stdout):
456 |     def _dump_line(dpos, equal=0):
457 |         print("%5d%s" % (dpos, " ="[equal]), end=' ', file=f)
458 |         for value in alist[dpos:dpos + stride]:
459 |             print(str(value), end=' ', file=f)
460 |         print(file=f)
461 |     pos = None
462 |     oldpos = None
463 |     for pos in xrange(0, len(alist), stride):
464 |         if oldpos is None:
465 |             _dump_line(pos)
466 |             oldpos = pos
467 |         elif alist[pos:pos+stride] != alist[oldpos:oldpos+stride]:
468 |             if pos - oldpos > stride:
469 |                 _dump_line(pos - stride, equal=1)
470 |             _dump_line(pos)
471 |             oldpos = pos
472 |     if oldpos is not None and pos is not None and pos != oldpos:
473 |         _dump_line(pos, equal=1)
474 | 


--------------------------------------------------------------------------------
/src/xlrd/doc/compdoc.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
 2 | <html>
 3 | <head>
 4 | <meta http-equiv='Content-Type' content='text/html; charset=us-ascii' />
 5 | <title>The compdoc Module</title>
 6 | </head>
 7 | <body>
 8 | <h1>The compdoc Module</h1>
 9 | <p>Implements the minimal functionality required
10 | to extract a "Workbook" or "Book" stream (as one big string)
11 | from an OLE2 Compound Document file.
12 | </p><p>Copyright &#169; 2005-2012 Stephen John Machin, Lingfo Pty Ltd</p>
13 | <p>This module is part of the xlrd package, which is released under a BSD-style licence.</p>
14 | <h2>Module Contents</h2>
15 | <dl>
16 | <dt><b>CompDoc(mem, logfile=sys.stdout, DEBUG=0)</b> (class) [<a href='#compdoc.CompDoc-class'>#</a>]</dt>
17 | <dd>
18 | <p>Compound document handler.</p>
19 | <dl>
20 | <dt><i>mem</i></dt>
21 | <dd>
22 | The raw contents of the file, as a string, or as an mmap.mmap() object. The
23 | only operation it needs to support is slicing.</dd>
24 | </dl><br />
25 | <p>For more information about this class, see <a href='#compdoc.CompDoc-class'><i>The CompDoc Class</i></a>.</p>
26 | </dd>
27 | <dt><a id='compdoc.SIGNATURE-variable' name='compdoc.SIGNATURE-variable'><b>SIGNATURE</b></a> (variable) [<a href='#compdoc.SIGNATURE-variable'>#</a>]</dt>
28 | <dd>
29 | <p>Magic cookie that should appear in the first 8 bytes of the file.</p>
30 | </dd>
31 | </dl>
32 | <h2><a id='compdoc.CompDoc-class' name='compdoc.CompDoc-class'>The CompDoc Class</a></h2>
33 | <dl>
34 | <dt><b>CompDoc(mem, logfile=sys.stdout, DEBUG=0)</b> (class) [<a href='#compdoc.CompDoc-class'>#</a>]</dt>
35 | <dd>
36 | <p>Compound document handler.</p>
37 | <dl>
38 | <dt><i>mem</i></dt>
39 | <dd>
40 | The raw contents of the file, as a string, or as an mmap.mmap() object. The
41 | only operation it needs to support is slicing.</dd>
42 | </dl><br />
43 | </dd>
44 | <dt><a id='compdoc.CompDoc.get_named_stream-method' name='compdoc.CompDoc.get_named_stream-method'><b>get_named_stream(qname)</b></a> [<a href='#compdoc.CompDoc.get_named_stream-method'>#</a>]</dt>
45 | <dd>
46 | <p>Interrogate the compound document's directory; return the stream as a string if found, otherwise
47 | return None.</p>
48 | <dl>
49 | <dt><i>qname</i></dt>
50 | <dd>
51 | Name of the desired stream e.g. u'Workbook'. Should be in Unicode or convertible thereto.</dd>
52 | </dl><br />
53 | </dd>
54 | <dt><a id='compdoc.CompDoc.locate_named_stream-method' name='compdoc.CompDoc.locate_named_stream-method'><b>locate_named_stream(qname)</b></a> [<a href='#compdoc.CompDoc.locate_named_stream-method'>#</a>]</dt>
55 | <dd>
56 | <p>Interrogate the compound document's directory.
57 | If the named stream is not found, (None, 0, 0) will be returned.
58 | If the named stream is found and is contiguous within the original byte sequence (&quot;mem&quot;)
59 | used when the document was opened,
60 | then (mem, offset_to_start_of_stream, length_of_stream) is returned.
61 | Otherwise a new string is built from the fragments and (new_string, 0, length_of_stream) is returned.</p>
62 | <dl>
63 | <dt><i>qname</i></dt>
64 | <dd>
65 | Name of the desired stream e.g. u'Workbook'. Should be in Unicode or convertible thereto.</dd>
66 | </dl><br />
67 | </dd>
68 | </dl>
69 | </body></html>
70 | 


--------------------------------------------------------------------------------
/src/xlrd/examples/namesdemo.xls:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/examples/namesdemo.xls


--------------------------------------------------------------------------------
/src/xlrd/examples/xlrdnameAPIdemo.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/examples/xlrdnameAPIdemo.py


--------------------------------------------------------------------------------
/src/xlrd/formatting.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/formatting.py


--------------------------------------------------------------------------------
/src/xlrd/formula.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/formula.py


--------------------------------------------------------------------------------
/src/xlrd/info.py:
--------------------------------------------------------------------------------
1 | __VERSION__ = "0.9.4"
2 | 


--------------------------------------------------------------------------------
/src/xlrd/licences.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/licences.py


--------------------------------------------------------------------------------
/src/xlrd/sheet.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/sheet.py


--------------------------------------------------------------------------------
/src/xlrd/timemachine.py:
--------------------------------------------------------------------------------
 1 | ##
 2 | # <p>Copyright (c) 2006-2012 Stephen John Machin, Lingfo Pty Ltd</p>
 3 | # <p>This module is part of the xlrd package, which is released under a BSD-style licence.</p>
 4 | ##
 5 | 
 6 | # timemachine.py -- adaptation for single codebase.
 7 | # Currently supported: 2.6 to 2.7, 3.2+
 8 | # usage: from timemachine import *
 9 | 
10 | from __future__ import print_function
11 | import sys
12 | 
13 | python_version = sys.version_info[:2] # e.g. version 2.6 -> (2, 6)
14 | 
15 | if python_version >= (3, 0):
16 |     # Python 3
17 |     BYTES_LITERAL = lambda x: x.encode('latin1')
18 |     UNICODE_LITERAL = lambda x: x
19 |     BYTES_ORD = lambda byte: byte
20 |     from io import BytesIO as BYTES_IO
21 |     def fprintf(f, fmt, *vargs):
22 |         fmt = fmt.replace("%r", "%a")
23 |         if fmt.endswith('\n'):
24 |             print(fmt[:-1] % vargs, file=f)
25 |         else:
26 |             print(fmt % vargs, end=' ', file=f)        
27 |     EXCEL_TEXT_TYPES = (str, bytes, bytearray) # xlwt: isinstance(obj, EXCEL_TEXT_TYPES)
28 |     REPR = ascii
29 |     xrange = range
30 |     unicode = lambda b, enc: b.decode(enc)
31 |     ensure_unicode = lambda s: s
32 |     unichr = chr
33 | else:
34 |     # Python 2
35 |     BYTES_LITERAL = lambda x: x
36 |     UNICODE_LITERAL = lambda x: x.decode('latin1')
37 |     BYTES_ORD = ord
38 |     from cStringIO import StringIO as BYTES_IO
39 |     def fprintf(f, fmt, *vargs):
40 |         if fmt.endswith('\n'):
41 |             print(fmt[:-1] % vargs, file=f)
42 |         else:
43 |             print(fmt % vargs, end=' ', file=f)        
44 |     try:
45 |         EXCEL_TEXT_TYPES = basestring # xlwt: isinstance(obj, EXCEL_TEXT_TYPES)
46 |     except NameError:
47 |         EXCEL_TEXT_TYPES = (str, unicode)
48 |     REPR = repr
49 |     xrange = xrange
50 |     # following used only to overcome 2.x ElementTree gimmick which
51 |     # returns text as `str` if it's ascii, otherwise `unicode`
52 |     ensure_unicode = unicode # used only in xlsx.py 
53 | 


--------------------------------------------------------------------------------
/src/xlrd/xldate.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/deanishe/i-sheet-you-not/ffebaa0248336fad333ba408f31f9001aefafb8a/src/xlrd/xldate.py


--------------------------------------------------------------------------------
/src/xlrd/xlsx.py:
--------------------------------------------------------------------------------
  1 | ##
  2 | # Portions copyright (c) 2008-2012 Stephen John Machin, Lingfo Pty Ltd
  3 | # This module is part of the xlrd package, which is released under a BSD-style licence.
  4 | ##
  5 | 
  6 | from __future__ import print_function, unicode_literals
  7 | 
  8 | DEBUG = 0
  9 | 
 10 | import sys
 11 | import re
 12 | from .timemachine import *
 13 | from .book import Book, Name
 14 | from .biffh import error_text_from_code, XLRDError, XL_CELL_BLANK, XL_CELL_TEXT, XL_CELL_BOOLEAN, XL_CELL_ERROR
 15 | from .formatting import is_date_format_string, Format, XF
 16 | from .sheet import Sheet
 17 | 
 18 | DLF = sys.stdout # Default Log File
 19 | 
 20 | ET = None
 21 | ET_has_iterparse = False
 22 | Element_has_iter = False
 23 | 
 24 | def ensure_elementtree_imported(verbosity, logfile):
 25 |     global ET, ET_has_iterparse, Element_has_iter
 26 |     if ET is not None:
 27 |         return
 28 |     if "IronPython" in sys.version:
 29 |         import xml.etree.ElementTree as ET
 30 |         #### 2.7.2.1: fails later with 
 31 |         #### NotImplementedError: iterparse is not supported on IronPython. (CP #31923)
 32 |     else:
 33 |         try: import xml.etree.cElementTree as ET
 34 |         except ImportError:
 35 |             try: import cElementTree as ET
 36 |             except ImportError:
 37 |                 try: import lxml.etree as ET
 38 |                 except ImportError:
 39 |                     try: import xml.etree.ElementTree as ET
 40 |                     except ImportError:
 41 |                         try: import elementtree.ElementTree as ET
 42 |                         except ImportError:
 43 |                             raise Exception("Failed to import an ElementTree implementation")
 44 |     if hasattr(ET, 'iterparse'):
 45 |         _dummy_stream = BYTES_IO(b'')
 46 |         try:
 47 |             ET.iterparse(_dummy_stream)
 48 |             ET_has_iterparse = True
 49 |         except NotImplementedError:
 50 |             pass
 51 |     Element_has_iter = hasattr(ET.ElementTree, 'iter')
 52 |     if verbosity:
 53 |         etree_version = repr([
 54 |             (item, getattr(ET, item))
 55 |             for item in ET.__dict__.keys()
 56 |             if item.lower().replace('_', '') == 'version'
 57 |             ])
 58 |         print(ET.__file__, ET.__name__, etree_version, ET_has_iterparse, file=logfile)
 59 |         
 60 | def split_tag(tag):
 61 |     pos = tag.rfind('}') + 1
 62 |     if pos >= 2:
 63 |         return tag[:pos], tag[pos:]
 64 |     return '', tag
 65 | 
 66 | def augment_keys(adict, uri):
 67 |     # uri must already be enclosed in {}
 68 |     for x in list(adict.keys()):
 69 |         adict[uri + x] = adict[x]
 70 | 
 71 | _UPPERCASE_1_REL_INDEX = {} # Used in fast conversion of column names (e.g. "XFD") to indices (16383)
 72 | for _x in xrange(26):
 73 |     _UPPERCASE_1_REL_INDEX["ABCDEFGHIJKLMNOPQRSTUVWXYZ"[_x]] = _x + 1
 74 | for _x in "123456789":
 75 |     _UPPERCASE_1_REL_INDEX[_x] = 0
 76 | del _x
 77 | 
 78 | def cell_name_to_rowx_colx(cell_name, letter_value=_UPPERCASE_1_REL_INDEX):
 79 |     # Extract column index from cell name
 80 |     # A<row number> => 0, Z =>25, AA => 26, XFD => 16383
 81 |     colx = 0
 82 |     charx = -1
 83 |     try:
 84 |         for c in cell_name:
 85 |             charx += 1
 86 |             lv = letter_value[c]
 87 |             if lv:
 88 |                 colx = colx * 26 + lv
 89 |             else: # start of row number; can't be '0'
 90 |                 colx = colx - 1
 91 |                 assert 0 <= colx < X12_MAX_COLS
 92 |                 break
 93 |     except KeyError:
 94 |         raise Exception('Unexpected character %r in cell name %r' % (c, cell_name))
 95 |     rowx = int(cell_name[charx:]) - 1
 96 |     return rowx, colx
 97 | 
 98 | error_code_from_text = {}
 99 | for _code, _text in error_text_from_code.items():
100 |     error_code_from_text[_text] = _code
101 | 
102 | # === X12 === Excel 2007 .xlsx ===============================================
103 | 
104 | U_SSML12 = "{http://schemas.openxmlformats.org/spreadsheetml/2006/main}"
105 | U_ODREL = "{http://schemas.openxmlformats.org/officeDocument/2006/relationships}"
106 | U_PKGREL = "{http://schemas.openxmlformats.org/package/2006/relationships}"
107 | U_CP = "{http://schemas.openxmlformats.org/package/2006/metadata/core-properties}"
108 | U_DC = "{http://purl.org/dc/elements/1.1/}"
109 | U_DCTERMS = "{http://purl.org/dc/terms/}"
110 | XML_SPACE_ATTR = "{http://www.w3.org/XML/1998/namespace}space"
111 | XML_WHITESPACE = "\t\n \r"
112 | X12_MAX_ROWS = 2 ** 20
113 | X12_MAX_COLS = 2 ** 14
114 | V_TAG = U_SSML12 + 'v' # cell child: value
115 | F_TAG = U_SSML12 + 'f' # cell child: formula
116 | IS_TAG = U_SSML12 + 'is' # cell child: inline string
117 | 
118 | def unescape(s,
119 |     subber=re.compile(r'_x[0-9A-Fa-f]{4,4}_', re.UNICODE).sub,
120 |     repl=lambda mobj: unichr(int(mobj.group(0)[2:6], 16)),
121 |     ):
122 |     if "_" in s:
123 |         return subber(repl, s)
124 |     return s
125 | 
126 | def cooked_text(self, elem):
127 |     t = elem.text
128 |     if t is None:
129 |         return ''
130 |     if elem.get(XML_SPACE_ATTR) != 'preserve':
131 |         t = t.strip(XML_WHITESPACE)
132 |     return ensure_unicode(unescape(t))
133 | 
134 | def get_text_from_si_or_is(self, elem, r_tag=U_SSML12+'r', t_tag=U_SSML12 +'t'):
135 |     "Returns unescaped unicode"
136 |     accum = []
137 |     for child in elem:
138 |         # self.dump_elem(child)
139 |         tag = child.tag
140 |         if tag == t_tag:
141 |             t = cooked_text(self, child)
142 |             if t: # note: .text attribute can be None
143 |                 accum.append(t)
144 |         elif tag == r_tag:
145 |             for tnode in child:
146 |                 if tnode.tag == t_tag:
147 |                     t = cooked_text(self, tnode)
148 |                     if t:
149 |                         accum.append(t)
150 |     return ''.join(accum)
151 | 
152 | def map_attributes(amap, elem, obj):
153 |     for xml_attr, obj_attr, cnv_func_or_const in amap:
154 |         if not xml_attr:
155 |             setattr(obj, obj_attr, cnv_func_or_const)
156 |             continue
157 |         if not obj_attr: continue #### FIX ME ####
158 |         raw_value = elem.get(xml_attr)
159 |         cooked_value = cnv_func_or_const(raw_value)
160 |         setattr(obj, obj_attr, cooked_value)
161 | 
162 | def cnv_ST_Xstring(s):
163 |     if s is None: return ""
164 |     return ensure_unicode(s)
165 | 
166 | def cnv_xsd_unsignedInt(s):
167 |     if not s:
168 |         return None
169 |     value = int(s)
170 |     assert value >= 0
171 |     return value
172 | 
173 | def cnv_xsd_boolean(s):
174 |     if not s:
175 |         return 0
176 |     if s in ("1", "true", "on"):
177 |         return 1
178 |     if s in ("0", "false", "off"):
179 |         return 0
180 |     raise ValueError("unexpected xsd:boolean value: %r" % s)
181 | 
182 | 
183 | _defined_name_attribute_map = (
184 |     ("name",                "name",         cnv_ST_Xstring, ),
185 |     ("comment",             "",             cnv_ST_Xstring, ),
186 |     ("customMenu",          "",             cnv_ST_Xstring, ),
187 |     ("description",         "",             cnv_ST_Xstring, ),
188 |     ("help",                "",             cnv_ST_Xstring, ),
189 |     ("statusBar",           "",             cnv_ST_Xstring, ),
190 |     ("localSheetId",        "scope",        cnv_xsd_unsignedInt, ),
191 |     ("hidden",              "hidden",       cnv_xsd_boolean, ),
192 |     ("function",            "func",         cnv_xsd_boolean, ),
193 |     ("vbProcedure",         "vbasic",       cnv_xsd_boolean, ),
194 |     ("xlm",                 "macro",        cnv_xsd_boolean, ),
195 |     ("functionGroupId",     "funcgroup",    cnv_xsd_unsignedInt, ),
196 |     ("shortcutKey",         "",             cnv_ST_Xstring,  ),
197 |     ("publishToServer",     "",             cnv_xsd_boolean, ),
198 |     ("workbookParameter",   "",             cnv_xsd_boolean, ),
199 |     ("",                    "any_err",      0,               ),
200 |     ("",                    "any_external", 0,               ),
201 |     ("",                    "any_rel",      0,               ),
202 |     ("",                    "basic_formula_len", 0,          ),
203 |     ("",                    "binary",       0,               ),
204 |     ("",                    "builtin",      0,               ),
205 |     ("",                    "complex",      0,               ),
206 |     ("",                    "evaluated",    0,               ),
207 |     ("",                    "excel_sheet_index", 0,          ),
208 |     ("",                    "excel_sheet_num", 0,            ),
209 |     ("",                    "option_flags", 0,               ),
210 |     ("",                    "result",       None,            ),
211 |     ("",                    "stack",        None,            ),
212 |     )
213 | 
214 | def make_name_access_maps(bk):
215 |     name_and_scope_map = {} # (name.lower(), scope): Name_object
216 |     name_map = {}           # name.lower() : list of Name_objects (sorted in scope order)
217 |     num_names = len(bk.name_obj_list)
218 |     for namex in xrange(num_names):
219 |         nobj = bk.name_obj_list[namex]
220 |         name_lcase = nobj.name.lower()
221 |         key = (name_lcase, nobj.scope)
222 |         if key in name_and_scope_map:
223 |             msg = 'Duplicate entry %r in name_and_scope_map' % (key, )
224 |             if 0:
225 |                 raise XLRDError(msg)
226 |             else:
227 |                 if bk.verbosity:
228 |                     print(msg, file=bk.logfile)
229 |         name_and_scope_map[key] = nobj
230 |         sort_data = (nobj.scope, namex, nobj)
231 |         if name_lcase in name_map:
232 |             name_map[name_lcase].append(sort_data)
233 |         else:
234 |             name_map[name_lcase] = [sort_data]
235 |     for key in name_map.keys():
236 |         alist = name_map[key]
237 |         alist.sort()
238 |         name_map[key] = [x[2] for x in alist]
239 |     bk.name_and_scope_map = name_and_scope_map
240 |     bk.name_map = name_map
241 | 
242 | class X12General(object):
243 | 
244 |     def process_stream(self, stream, heading=None):
245 |         if self.verbosity >= 2 and heading is not None:
246 |             fprintf(self.logfile, "\n=== %s ===\n", heading)
247 |         self.tree = ET.parse(stream)
248 |         getmethod = self.tag2meth.get
249 |         for elem in self.tree.iter() if Element_has_iter else self.tree.getiterator():
250 |             if self.verbosity >= 3:
251 |                 self.dump_elem(elem)
252 |             meth = getmethod(elem.tag)
253 |             if meth:
254 |                 meth(self, elem)
255 |         self.finish_off()
256 | 
257 |     def finish_off(self):
258 |         pass
259 | 
260 |     def dump_elem(self, elem):
261 |         fprintf(self.logfile,
262 |             "===\ntag=%r len=%d attrib=%r text=%r tail=%r\n",
263 |             split_tag(elem.tag)[1], len(elem), elem.attrib, elem.text, elem.tail)
264 | 
265 |     def dumpout(self, fmt, *vargs):
266 |         text = (12 * ' ' + fmt + '\n') % vargs
267 |         self.logfile.write(text)
268 | 
269 | class X12Book(X12General):
270 | 
271 |     def __init__(self, bk, logfile=DLF, verbosity=False):
272 |         self.bk = bk
273 |         self.logfile = logfile
274 |         self.verbosity = verbosity
275 |         self.bk.nsheets = 0
276 |         self.bk.props = {}
277 |         self.relid2path = {}
278 |         self.relid2reltype = {}
279 |         self.sheet_targets = [] # indexed by sheetx
280 |         self.sheetIds = [] # indexed by sheetx
281 | 
282 |     core_props_menu = {
283 |         U_CP+"lastModifiedBy": ("last_modified_by", cnv_ST_Xstring),
284 |         U_DC+"creator": ("creator", cnv_ST_Xstring),
285 |         U_DCTERMS+"modified": ("modified", cnv_ST_Xstring),
286 |         U_DCTERMS+"created": ("created", cnv_ST_Xstring),
287 |         }
288 | 
289 |     def process_coreprops(self, stream):
290 |         if self.verbosity >= 2:
291 |             fprintf(self.logfile, "\n=== coreProps ===\n")
292 |         self.tree = ET.parse(stream)
293 |         getmenu = self.core_props_menu.get
294 |         props = {}
295 |         for elem in self.tree.iter() if Element_has_iter else self.tree.getiterator():
296 |             if self.verbosity >= 3:
297 |                 self.dump_elem(elem)
298 |             menu = getmenu(elem.tag)
299 |             if menu:
300 |                 attr, func = menu
301 |                 value = func(elem.text)
302 |                 props[attr] = value
303 |         self.bk.user_name = props.get('last_modified_by') or props.get('creator')
304 |         self.bk.props = props
305 |         if self.verbosity >= 2:
306 |             fprintf(self.logfile, "props: %r\n", props)
307 |         self.finish_off()
308 | 
309 |     def process_rels(self, stream):
310 |         if self.verbosity >= 2:
311 |             fprintf(self.logfile, "\n=== Relationships ===\n")
312 |         tree = ET.parse(stream)
313 |         r_tag = U_PKGREL + 'Relationship'
314 |         for elem in tree.findall(r_tag):
315 |             rid = elem.get('Id')
316 |             target = elem.get('Target')
317 |             reltype = elem.get('Type').split('/')[-1]
318 |             if self.verbosity >= 2:
319 |                 self.dumpout('Id=%r Type=%r Target=%r', rid, reltype, target)
320 |             self.relid2reltype[rid] = reltype
321 |             # self.relid2path[rid] = 'xl/' + target
322 |             if target.startswith('/'):
323 |                 self.relid2path[rid]  = target[1:] # drop the /
324 |             else:
325 |                 self.relid2path[rid] = 'xl/' + target
326 | 
327 |     def do_defined_name(self, elem):
328 |         #### UNDER CONSTRUCTION ####
329 |         if 0 and self.verbosity >= 3:
330 |             self.dump_elem(elem)
331 |         nobj = Name()
332 |         bk = self.bk
333 |         nobj.bk = bk
334 |         nobj.name_index = len(bk.name_obj_list)
335 |         bk.name_obj_list.append(nobj)
336 |         nobj.name = elem.get('name')
337 |         nobj.raw_formula = None # compiled bytecode formula -- not in XLSX
338 |         nobj.formula_text = cooked_text(self, elem)
339 |         map_attributes(_defined_name_attribute_map, elem, nobj)
340 |         if nobj.scope is None:
341 |             nobj.scope = -1 # global
342 |         if nobj.name.startswith("_xlnm."):
343 |             nobj.builtin = 1
344 |         if self.verbosity >= 2:
345 |             nobj.dump(header='=== Name object ===')
346 | 
347 |     def do_defined_names(self, elem):
348 |         for child in elem:
349 |             self.do_defined_name(child)
350 |         make_name_access_maps(self.bk)
351 | 
352 |     def do_sheet(self, elem):
353 |         bk = self.bk
354 |         sheetx = bk.nsheets
355 |         # print elem.attrib
356 |         rid = elem.get(U_ODREL + 'id')
357 |         sheetId = int(elem.get('sheetId'))
358 |         name = unescape(ensure_unicode(elem.get('name')))
359 |         reltype = self.relid2reltype[rid]
360 |         target = self.relid2path[rid]
361 |         if self.verbosity >= 2:
362 |             self.dumpout(
363 |                 'sheetx=%d sheetId=%r rid=%r type=%r name=%r',
364 |                 sheetx, sheetId, rid, reltype, name)
365 |         if reltype != 'worksheet':
366 |             if self.verbosity >= 2:
367 |                 self.dumpout('Ignoring sheet of type %r (name=%r)', reltype, name)
368 |             return
369 |         state = elem.get('state')
370 |         visibility_map = {
371 |             None: 0,
372 |             'visible': 0,
373 |             'hidden': 1,
374 |             'veryHidden': 2
375 |             }
376 |         bk._sheet_visibility.append(visibility_map[state])
377 |         sheet = Sheet(bk, position=None, name=name, number=sheetx)
378 |         sheet.utter_max_rows = X12_MAX_ROWS
379 |         sheet.utter_max_cols = X12_MAX_COLS
380 |         bk._sheet_list.append(sheet)
381 |         bk._sheet_names.append(name)
382 |         bk.nsheets += 1
383 |         self.sheet_targets.append(target)
384 |         self.sheetIds.append(sheetId)
385 | 
386 | 
387 |     def do_workbookpr(self, elem):
388 |         datemode = cnv_xsd_boolean(elem.get('date1904'))
389 |         if self.verbosity >= 2:
390 |             self.dumpout('datemode=%r', datemode)
391 |         self.bk.datemode = datemode
392 | 
393 |     tag2meth = {
394 |         'definedNames':  do_defined_names,
395 |         'workbookPr':   do_workbookpr,
396 |         'sheet':        do_sheet,
397 |         }
398 |     augment_keys(tag2meth, U_SSML12)
399 | 
400 | class X12SST(X12General):
401 | 
402 |     def __init__(self, bk, logfile=DLF, verbosity=0):
403 |         self.bk = bk
404 |         self.logfile = logfile
405 |         self.verbosity = verbosity
406 |         if ET_has_iterparse:
407 |             self.process_stream = self.process_stream_iterparse
408 |         else:
409 |             self.process_stream = self.process_stream_findall
410 |             
411 |     def process_stream_iterparse(self, stream, heading=None):
412 |         if self.verbosity >= 2 and heading is not None:
413 |             fprintf(self.logfile, "\n=== %s ===\n", heading)
414 |         si_tag = U_SSML12 + 'si'
415 |         elemno = -1
416 |         sst = self.bk._sharedstrings
417 |         for event, elem in ET.iterparse(stream):
418 |             if elem.tag != si_tag: continue
419 |             elemno = elemno + 1
420 |             if self.verbosity >= 3:
421 |                 fprintf(self.logfile, "element #%d\n", elemno)
422 |                 self.dump_elem(elem)
423 |             result = get_text_from_si_or_is(self, elem)
424 |             sst.append(result)                
425 |             elem.clear() # destroy all child elements
426 |         if self.verbosity >= 2:
427 |             self.dumpout('Entries in SST: %d', len(sst))
428 |         if self.verbosity >= 3:
429 |             for x, s in enumerate(sst):
430 |                 fprintf(self.logfile, "SST x=%d s=%r\n", x, s)
431 | 
432 |     def process_stream_findall(self, stream, heading=None):
433 |         if self.verbosity >= 2 and heading is not None:
434 |             fprintf(self.logfile, "\n=== %s ===\n", heading)
435 |         self.tree = ET.parse(stream)
436 |         si_tag = U_SSML12 + 'si'
437 |         elemno = -1
438 |         sst = self.bk._sharedstrings
439 |         for elem in self.tree.findall(si_tag):
440 |             elemno = elemno + 1
441 |             if self.verbosity >= 3:
442 |                 fprintf(self.logfile, "element #%d\n", elemno)
443 |                 self.dump_elem(elem)
444 |             result = get_text_from_si_or_is(self, elem)
445 |             sst.append(result)
446 |         if self.verbosity >= 2:
447 |             self.dumpout('Entries in SST: %d', len(sst))
448 | 
449 | class X12Styles(X12General):
450 | 
451 |     def __init__(self, bk, logfile=DLF, verbosity=0):
452 |         self.bk = bk
453 |         self.logfile = logfile
454 |         self.verbosity = verbosity
455 |         self.xf_counts = [0, 0]
456 |         self.xf_type = None
457 |         self.fmt_is_date = {}
458 |         for x in list(range(14, 23)) + list(range(45, 48)): #### hard-coding FIX ME ####
459 |             self.fmt_is_date[x] = 1
460 |         # dummy entry for XF 0 in case no Styles section
461 |         self.bk._xf_index_to_xl_type_map[0] = 2
462 |         # fill_in_standard_formats(bk) #### pre-integration kludge
463 | 
464 |     def do_cellstylexfs(self, elem):
465 |         self.xf_type = 0
466 | 
467 |     def do_cellxfs(self, elem):
468 |         self.xf_type = 1
469 | 
470 |     def do_numfmt(self, elem):
471 |         formatCode = ensure_unicode(elem.get('formatCode'))
472 |         numFmtId = int(elem.get('numFmtId'))
473 |         is_date = is_date_format_string(self.bk, formatCode)
474 |         self.fmt_is_date[numFmtId] = is_date
475 |         fmt_obj = Format(numFmtId, is_date + 2, formatCode)
476 |         self.bk.format_map[numFmtId] = fmt_obj
477 |         if self.verbosity >= 3:
478 |             self.dumpout('numFmtId=%d formatCode=%r is_date=%d', numFmtId, formatCode, is_date)
479 | 
480 |     def do_xf(self, elem):
481 |         if self.xf_type != 1:
482 |             #### ignoring style XFs for the moment
483 |             return
484 |         xfx = self.xf_counts[self.xf_type]
485 |         self.xf_counts[self.xf_type] = xfx + 1
486 |         xf = XF()
487 |         self.bk.xf_list.append(xf)
488 |         self.bk.xfcount += 1
489 |         numFmtId = int(elem.get('numFmtId', '0'))
490 |         xf.format_key = numFmtId
491 |         is_date = self.fmt_is_date.get(numFmtId, 0)
492 |         self.bk._xf_index_to_xl_type_map[xfx] = is_date + 2
493 |         if self.verbosity >= 3:
494 |             self.dumpout(
495 |                 'xfx=%d numFmtId=%d',
496 |                 xfx, numFmtId,
497 |                 )
498 |             self.dumpout(repr(self.bk._xf_index_to_xl_type_map))
499 | 
500 |     tag2meth = {
501 |         'cellStyleXfs': do_cellstylexfs,
502 |         'cellXfs':      do_cellxfs,
503 |         'numFmt':       do_numfmt,
504 |         'xf':           do_xf,
505 |         }
506 |     augment_keys(tag2meth, U_SSML12)
507 | 
508 | class X12Sheet(X12General):
509 | 
510 |     def __init__(self, sheet, logfile=DLF, verbosity=0):
511 |         self.sheet = sheet
512 |         self.logfile = logfile
513 |         self.verbosity = verbosity
514 |         self.rowx = -1 # We may need to count them.
515 |         self.bk = sheet.book
516 |         self.sst = self.bk._sharedstrings
517 |         self.merged_cells = sheet.merged_cells
518 |         self.warned_no_cell_name = 0
519 |         self.warned_no_row_num = 0
520 |         if ET_has_iterparse:
521 |             self.process_stream = self.own_process_stream
522 | 
523 |     def own_process_stream(self, stream, heading=None):
524 |         if self.verbosity >= 2 and heading is not None:
525 |             fprintf(self.logfile, "\n=== %s ===\n", heading)
526 |         getmethod = self.tag2meth.get
527 |         row_tag = U_SSML12 + "row"
528 |         self_do_row = self.do_row
529 |         for event, elem in ET.iterparse(stream):
530 |             if elem.tag == row_tag:
531 |                 self_do_row(elem)
532 |                 elem.clear() # destroy all child elements (cells)
533 |             elif elem.tag == U_SSML12 + "dimension":
534 |                 self.do_dimension(elem)
535 |             elif elem.tag == U_SSML12 + "mergeCell":
536 |                 self.do_merge_cell(elem)
537 |         self.finish_off()
538 | 
539 |     def process_comments_stream(self, stream):
540 |         root = ET.parse(stream).getroot()
541 |         author_list = root[0]
542 |         assert author_list.tag == U_SSML12 + 'authors'
543 |         authors = [elem.text for elem in author_list]
544 |         comment_list = root[1]
545 |         assert comment_list.tag == U_SSML12 + 'commentList'
546 |         cell_note_map = self.sheet.cell_note_map
547 |         from .sheet import Note
548 |         text_tag = U_SSML12 + 'text'
549 |         r_tag = U_SSML12 + 'r'
550 |         t_tag = U_SSML12 + 't'
551 |         for elem in comment_list.findall(U_SSML12 + 'comment'):
552 |             ts = elem.findall('./' + text_tag + '/' + t_tag)
553 |             ts += elem.findall('./' + text_tag + '/' + r_tag + '/' + t_tag)
554 |             ref = elem.get('ref')
555 |             note = Note()
556 |             note.author = authors[int(elem.get('authorId'))]
557 |             note.rowx, note.colx = coords = cell_name_to_rowx_colx(ref)
558 |             note.text = ''
559 |             for t in ts:
560 |                 note.text += cooked_text(self, t)
561 |             cell_note_map[coords] = note
562 | 
563 |     def do_dimension(self, elem):
564 |         ref = elem.get('ref') # example: "A1:Z99" or just "A1"
565 |         if ref:
566 |             # print >> self.logfile, "dimension: ref=%r" % ref
567 |             last_cell_ref = ref.split(':')[-1] # example: "Z99"
568 |             rowx, colx = cell_name_to_rowx_colx(last_cell_ref)
569 |             self.sheet._dimnrows = rowx + 1
570 |             self.sheet._dimncols = colx + 1
571 | 
572 |     def do_merge_cell(self, elem):
573 |         # The ref attribute should be a cell range like "B1:D5".
574 |         ref = elem.get('ref')
575 |         if ref:
576 |             first_cell_ref, last_cell_ref = ref.split(':')
577 |             first_rowx, first_colx = cell_name_to_rowx_colx(first_cell_ref)
578 |             last_rowx, last_colx = cell_name_to_rowx_colx(last_cell_ref)
579 |             self.merged_cells.append((first_rowx, last_rowx + 1,
580 |                                       first_colx, last_colx + 1))
581 | 
582 |     def do_row(self, row_elem):
583 |     
584 |         def bad_child_tag(child_tag):
585 |              raise Exception('cell type %s has unexpected child <%s> at rowx=%r colx=%r' % (cell_type, child_tag, rowx, colx))
586 |  
587 |         row_number = row_elem.get('r')
588 |         if row_number is None: # Yes, it's optional.
589 |             self.rowx += 1
590 |             explicit_row_number = 0
591 |             if self.verbosity and not self.warned_no_row_num:
592 |                 self.dumpout("no row number; assuming rowx=%d", self.rowx)
593 |                 self.warned_no_row_num = 1
594 |         else:
595 |             self.rowx = int(row_number) - 1
596 |             explicit_row_number = 1
597 |         assert 0 <= self.rowx < X12_MAX_ROWS
598 |         rowx = self.rowx
599 |         colx = -1
600 |         if self.verbosity >= 3:
601 |             self.dumpout("<row> row_number=%r rowx=%d explicit=%d",
602 |                 row_number, self.rowx, explicit_row_number)
603 |         letter_value = _UPPERCASE_1_REL_INDEX
604 |         for cell_elem in row_elem:
605 |             cell_name = cell_elem.get('r')
606 |             if cell_name is None: # Yes, it's optional.
607 |                 colx += 1
608 |                 if self.verbosity and not self.warned_no_cell_name:
609 |                     self.dumpout("no cellname; assuming rowx=%d colx=%d", rowx, colx)
610 |                     self.warned_no_cell_name = 1
611 |             else:
612 |                 # Extract column index from cell name
613 |                 # A<row number> => 0, Z =>25, AA => 26, XFD => 16383
614 |                 colx = 0
615 |                 charx = -1
616 |                 try:
617 |                     for c in cell_name:
618 |                         charx += 1
619 |                         if c == '$':
620 |                             continue
621 |                         lv = letter_value[c]
622 |                         if lv:
623 |                             colx = colx * 26 + lv
624 |                         else: # start of row number; can't be '0'
625 |                             colx = colx - 1
626 |                             assert 0 <= colx < X12_MAX_COLS
627 |                             break
628 |                 except KeyError:
629 |                     raise Exception('Unexpected character %r in cell name %r' % (c, cell_name))
630 |                 if explicit_row_number and cell_name[charx:] != row_number:
631 |                     raise Exception('cell name %r but row number is %r' % (cell_name, row_number))
632 |             xf_index = int(cell_elem.get('s', '0'))
633 |             cell_type = cell_elem.get('t', 'n')
634 |             tvalue = None
635 |             formula = None
636 |             if cell_type == 'n':
637 |                 # n = number. Most frequent type.
638 |                 # <v> child contains plain text which can go straight into float()
639 |                 # OR there's no text in which case it's a BLANK cell
640 |                 for child in cell_elem:
641 |                     child_tag = child.tag
642 |                     if child_tag == V_TAG:
643 |                         tvalue = child.text
644 |                     elif child_tag == F_TAG:
645 |                         formula = cooked_text(self, child)
646 |                     else:
647 |                         raise Exception('unexpected tag %r' % child_tag)
648 |                 if not tvalue:
649 |                     if self.bk.formatting_info:
650 |                         self.sheet.put_cell(rowx, colx, XL_CELL_BLANK, '', xf_index)
651 |                 else:
652 |                     self.sheet.put_cell(rowx, colx, None, float(tvalue), xf_index)
653 |             elif cell_type == "s":
654 |                 # s = index into shared string table. 2nd most frequent type
655 |                 # <v> child contains plain text which can go straight into int()
656 |                 for child in cell_elem:
657 |                     child_tag = child.tag
658 |                     if child_tag == V_TAG:
659 |                         tvalue = child.text
660 |                     elif child_tag == F_TAG:
661 |                         # formula not expected here, but gnumeric does it.
662 |                         formula = child.text
663 |                     else:
664 |                         bad_child_tag(child_tag)
665 |                 if not tvalue:
666 |                     # <c r="A1" t="s"/>
667 |                     if self.bk.formatting_info:
668 |                         self.sheet.put_cell(rowx, colx, XL_CELL_BLANK, '', xf_index)
669 |                 else:
670 |                     value = self.sst[int(tvalue)]
671 |                     self.sheet.put_cell(rowx, colx, XL_CELL_TEXT, value, xf_index)
672 |             elif cell_type == "str":
673 |                 # str = string result from formula.
674 |                 # Should have <f> (formula) child; however in one file, all text cells are str with no formula.
675 |                 # <v> child can contain escapes
676 |                 for child in cell_elem:
677 |                     child_tag = child.tag
678 |                     if child_tag == V_TAG:
679 |                         tvalue = cooked_text(self, child)
680 |                     elif child_tag == F_TAG:
681 |                         formula = cooked_text(self, child)
682 |                     else:
683 |                         bad_child_tag(child_tag)
684 |                 # assert tvalue is not None and formula is not None
685 |                 # Yuk. Fails with file created by gnumeric -- no tvalue!
686 |                 self.sheet.put_cell(rowx, colx, XL_CELL_TEXT, tvalue, xf_index)
687 |             elif cell_type == "b":
688 |                 # b = boolean
689 |                 # <v> child contains "0" or "1"
690 |                 # Maybe the data should be converted with cnv_xsd_boolean;
691 |                 # ECMA standard is silent; Excel 2007 writes 0 or 1
692 |                 for child in cell_elem:
693 |                     child_tag = child.tag
694 |                     if child_tag == V_TAG:
695 |                         tvalue = child.text
696 |                     elif child_tag == F_TAG:
697 |                         formula = cooked_text(self, child)
698 |                     else:
699 |                         bad_child_tag(child_tag)
700 |                 self.sheet.put_cell(rowx, colx, XL_CELL_BOOLEAN, int(tvalue), xf_index)
701 |             elif cell_type == "e":
702 |                 # e = error
703 |                 # <v> child contains e.g. "#REF!"
704 |                 for child in cell_elem:
705 |                     child_tag = child.tag
706 |                     if child_tag == V_TAG:
707 |                         tvalue = child.text
708 |                     elif child_tag == F_TAG:
709 |                         formula = cooked_text(self, child)
710 |                     else:
711 |                         bad_child_tag(child_tag)
712 |                 value = error_code_from_text[tvalue]
713 |                 self.sheet.put_cell(rowx, colx, XL_CELL_ERROR, value, xf_index)
714 |             elif cell_type == "inlineStr":
715 |                 # Not expected in files produced by Excel.
716 |                 # Only possible child is <is>.
717 |                 # It's a way of allowing 3rd party s/w to write text (including rich text) cells
718 |                 # without having to build a shared string table
719 |                 for child in cell_elem:
720 |                     child_tag = child.tag
721 |                     if child_tag == IS_TAG:
722 |                         tvalue = get_text_from_si_or_is(self, child)
723 |                     else:
724 |                         bad_child_tag(child_tag)
725 |                 assert tvalue is not None
726 |                 self.sheet.put_cell(rowx, colx, XL_CELL_TEXT, tvalue, xf_index)
727 |             else:
728 |                 raise Exception("Unknown cell type %r in rowx=%d colx=%d" % (cell_type, rowx, colx))
729 | 
730 |     tag2meth = {
731 |         'row':          do_row,
732 |         }
733 |     augment_keys(tag2meth, U_SSML12)
734 | 
735 | def open_workbook_2007_xml(
736 |     zf,
737 |     component_names,
738 |     logfile=sys.stdout,
739 |     verbosity=0,
740 |     use_mmap=0,
741 |     formatting_info=0,
742 |     on_demand=0,
743 |     ragged_rows=0,
744 |     ):
745 |     ensure_elementtree_imported(verbosity, logfile)
746 |     bk = Book()
747 |     bk.logfile = logfile
748 |     bk.verbosity = verbosity
749 |     bk.formatting_info = formatting_info
750 |     if formatting_info:
751 |         raise NotImplementedError("formatting_info=True not yet implemented")
752 |     bk.use_mmap = False #### Not supported initially
753 |     bk.on_demand = on_demand
754 |     if on_demand:
755 |         if verbosity:
756 |             print("WARNING *** on_demand=True not yet implemented; falling back to False", file=bk.logfile)
757 |         bk.on_demand = False
758 |     bk.ragged_rows = ragged_rows
759 | 
760 |     x12book = X12Book(bk, logfile, verbosity)
761 |     zflo = zf.open(component_names['xl/_rels/workbook.xml.rels'])
762 |     x12book.process_rels(zflo)
763 |     del zflo
764 |     zflo = zf.open(component_names['xl/workbook.xml'])
765 |     x12book.process_stream(zflo, 'Workbook')
766 |     del zflo
767 |     props_name = 'docprops/core.xml'
768 |     if props_name in component_names:
769 |         zflo = zf.open(component_names[props_name])
770 |         x12book.process_coreprops(zflo)
771 | 
772 |     x12sty = X12Styles(bk, logfile, verbosity)
773 |     if 'xl/styles.xml' in component_names:
774 |         zflo = zf.open(component_names['xl/styles.xml'])
775 |         x12sty.process_stream(zflo, 'styles')
776 |         del zflo
777 |     else:
778 |         # seen in MS sample file MergedCells.xlsx
779 |         pass
780 | 
781 |     sst_fname = 'xl/sharedstrings.xml'
782 |     x12sst = X12SST(bk, logfile, verbosity)
783 |     if sst_fname in component_names:
784 |         zflo = zf.open(component_names[sst_fname])
785 |         x12sst.process_stream(zflo, 'SST')
786 |         del zflo
787 | 
788 |     for sheetx in range(bk.nsheets):
789 |         fname = x12book.sheet_targets[sheetx]
790 |         zflo = zf.open(component_names[fname])
791 |         sheet = bk._sheet_list[sheetx]
792 |         x12sheet = X12Sheet(sheet, logfile, verbosity)
793 |         heading = "Sheet %r (sheetx=%d) from %r" % (sheet.name, sheetx, fname)
794 |         x12sheet.process_stream(zflo, heading)
795 |         del zflo
796 |         comments_fname = 'xl/comments%d.xml' % (sheetx + 1)
797 |         if comments_fname in component_names:
798 |             comments_stream = zf.open(component_names[comments_fname])
799 |             x12sheet.process_comments_stream(comments_stream)
800 |             del comments_stream
801 | 
802 |         sheet.tidy_dimensions()
803 | 
804 |     return bk
805 | 


--------------------------------------------------------------------------------