Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial Project commit

  • Loading branch information...
commit 5da51fb22c80a4df46f52fe00aab8d6ac0bc92a4 1 parent 6d6f394
David Miller authored
View
9 .travis.yml
@@ -0,0 +1,9 @@
+language: python
+python:
+ - "2.6"
+ - "2.7"
+ - "3.2"
+install:
+ - pip install -r requirements.txt --use-mirrors
+ - "if [[ $TRAVIS_PYTHON_VERSION == '2.6' ]]; then pip install unittest2; fi"
+script: rake test
View
202 COPYING.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
View
7 HISTORY.rst
@@ -0,0 +1,7 @@
+History
+-------
+
+0.0.1
++++++
+
+Initial release
View
3  MANIFEST.in
@@ -0,0 +1,3 @@
+include COPYING.txt
+include README.rst
+include HISTORY.rst
View
4 README.md
@@ -1,4 +0,0 @@
-ffs
-===
-
-Python Filesystem Api helpers
View
17 README.rst
@@ -0,0 +1,17 @@
+ffs
+===
+
+Python Filesystem Api helpers
+
+.. image:: https://secure.travis-ci.org/davidmiller/ffs.png?branch=master
+ :alt: Build Status
+ :target: https://secure.travis-ci.org/davidmiller/ffs
+
+Check out:
+
+`Source`_
+
+`Issues`_
+
+.. _Source: https://github.com/davidmiller/ffs
+.. _Issues: https://github.com/davidmiller/ffs/issues
View
8 Rakefile
@@ -0,0 +1,8 @@
+
+PROJ = "ffs"
+
+task :test, :python do |t, args|
+ p "Running unit tests for #{PROJ}"
+ args.with_defaults :python => "python"
+ sh "#{args[:python]} -m pytest test"
+end
View
153 doc/Makefile
@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FFs.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FFs.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/FFs"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FFs"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
View
246 doc/source/conf.py
@@ -0,0 +1,246 @@
+# -*- coding: utf-8 -*-
+#
+# FFs documentation build configuration file, created by
+# sphinx-quickstart on Wed Jul 25 13:12:55 2012.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'FFs'
+copyright = u'2012, David Miller'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'FFsdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'FFs.tex', u'FFs Documentation',
+ u'David Miller', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'ffs', u'FFs Documentation',
+ [u'David Miller'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'FFs', u'FFs Documentation',
+ u'David Miller', 'FFs', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}
View
22 doc/source/index.rst
@@ -0,0 +1,22 @@
+.. FFs documentation master file, created by
+ sphinx-quickstart on Wed Jul 25 13:12:55 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to FFs's documentation!
+===============================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
View
36 fabfile.py
@@ -0,0 +1,36 @@
+"""
+Fab commands for ffs
+"""
+
+from fabric.api import task, hosts, local, lcd, cd, run
+from fabric import operations
+
+deadpan = 'happenup@deadpansincerity.com'
+
+@task
+def test():
+ """
+ Run our unittests
+ """
+ local('python -m pytest test')
+
+@task
+def make_docs():
+ """
+ Rebuild the documentation
+ """
+ with lcd('doc/'):
+ local('make html')
+
+@task
+@hosts(deadpan)
+def upload_docs():
+ """
+ Build, compress, upload and extract the latest docs
+ """
+ with lcd('doc/build/html'):
+ local('rm -rf ffsdocs.tar.gz')
+ local('tar zcvf ffsdocs.tar.gz *')
+ operations.put('ffsdocs.tar.gz', '/home/happenup/webapps/ffsdocs/ffsdocs.tar.gz')
+ with cd('/home/happenup/webapps/ffsdocs/'):
+ run('tar zxvf ffsdocs.tar.gz')
View
158 ffs/__init__.py
@@ -0,0 +1,158 @@
+"""
+Filesystem API helpers
+"""
+import datetime
+import errno
+import os
+import sys
+
+ts2dt = datetime.datetime.utcfromtimestamp
+
+if sys.platform.startswith("win"):
+ OS = "WINDOWS!"
+else:
+ OS = "LINUX!"
+
+
+def _defensive_dperms(filename):
+ """
+ Check that the permissions of `filename`'s directory are sane
+ """
+ filename = os.path.abspath(filename)
+ targetdir = os.path.dirname(filename)
+ if not os.path.isdir(targetdir):
+ return False
+ return True
+
+def _defensive_access(filepath):
+ """
+ Defensively check for access to filepath
+
+ Arguments:
+ - `filepath`: str
+ """
+ filepath = os.path.abspath(filepath)
+ if not _defensive_dperms(filepath):
+ return False
+ if not os.path.exists(filepath):
+ return False
+ return True
+
+def mkdir_p(path):
+ """
+ Python translation of mkdir -p
+ """
+ try:
+ os.makedirs(path)
+ except OSError as exc: # Python >2.5
+ if exc.errno == errno.EEXIST:
+ pass
+ else: raise
+
+def basen(path, num=1):
+ """
+ Return the last `num` components of `path`
+
+ Arguments:
+ - `path`: str
+ - `num`: int
+
+ Return: str
+ Exceptions: None
+ """
+ # Almost certainly a faster algorithm for this.
+ # See testcase in test_fs for expected results
+ return os.sep.join(list(reversed([e for i, e in enumerate(reversed(path.split(os.sep))) if i < num])))
+
+def lsmtime(path, lessthan=None):
+ """
+ Return a list of all files existing in `path`
+ where their mtime is less than `lessthan`.
+
+ The return is a list of strings which are absolute paths
+ to the files.
+
+ Arguments:
+ - `path`: str
+ - `lessthan`: DateTime
+
+ Return: [str,]
+ Exceptions: None
+ """
+ for base, dirs, files in os.walk(path):
+ ls = []
+ for fname in files:
+ fpath = os.path.join(base, fname)
+ mtime = os.path.getmtime(fpath)
+ mtime = float(mtime) # Don't rely on os.stat_float_times() == True
+ mdatetime = ts2dt(mtime)
+ if mdatetime < lessthan:
+ ls.append(fpath)
+ return ls
+
+def rm(*targets):
+ """
+ API Wrapper around various invocations of the *nix
+ rm utility.
+
+
+ Arguments:
+ - `*targets`: all target paths
+
+ Return: None
+ Exceptions: None
+ """
+
+
+
+ return
+
+def hsize(filepath):
+ """
+ Return the size of the file at `filepath` as a hex string
+ or None if the file does not exist/is not accessible, printing
+ an appropriate warning.
+
+ Arguments:
+ - `filepath`: str
+ """
+ filename = os.path.abspath(filepath)
+ fsize = size(filepath)
+ if fsize:
+ return hex(fsize)
+ return None
+
+def size(filepath):
+ """
+ Return the integer value of the size of `filepath' in bytes
+
+ Arguments:
+ - `filepath`: str
+ """
+ filename = os.path.abspath(filepath)
+ if not _defensive_access(filepath):
+ return None
+ return int(os.stat(filename).st_size)
+
+def is_exe(fpath):
+ "Is `fpath' executable?"
+ return os.path.exists(fpath) and os.access(fpath, os.X_OK)
+
+
+def which(program):
+ """
+ Python port of the Unix which command.
+
+ Examine PATH to see if `program' is on it.
+ Return either the fully qualified filename or None
+ """
+ fpath, fname = os.path.split(program)
+ if fpath:
+ if is_exe(program):
+ return program
+ else:
+ for path in os.environ["PATH"].split(os.pathsep):
+ exe_file = os.path.join(path, program)
+ if is_exe(exe_file):
+ return exe_file
+ return None
View
1  ffs/_version.py
@@ -0,0 +1 @@
+__version__ = "0.0.1"
View
5 requirements.txt
@@ -0,0 +1,5 @@
+argparse==1.2.1
+mock==1.0b1
+py==1.4.9
+pytest==2.2.4
+wsgiref==0.1.2
View
33 setup.py
@@ -0,0 +1,33 @@
+import re
+
+from distutils.core import setup
+
+VERSION_FILE = "ffs/_version.py"
+verstrline = open(VERSION_FILE, "rt").read()
+VSRE = r'^__version__ = [\'"]([^\'"]*)[\'"]'
+mo = re.search(VSRE, verstrline, re.M)
+if mo:
+ VERSION = mo.group(1)
+else:
+ raise RuntimeError("Unable to find version string in {0}".format(VERSION_FILE))
+
+setup(
+ name = "ffs",
+ version = VERSION,
+ author = "David Miller",
+ author_email = "david@deadpansincerity.com",
+ url = "http://github.com/davidmiller/ffs",
+ description = "Python Filesystem Api helpers",
+ long_description = open('README.rst').read() + "\n\n" + open('HISTORY.rst').read(),
+ classifiers = [
+ "Programming Language :: Python",
+ "Programming Language :: Python :: 2.7",
+ "Programming Language :: Python :: 2.6",
+ "License :: OSI Approved :: Apache Software License",
+ "Operating System :: OS Independent",
+ "Development Status :: 4 - Beta",
+ "Intended Audience :: Developers",
+ "Topic :: Software Development :: Libraries"
+ ],
+ packages = ['ffs'],
+ )
View
121 test/test_ffs.py
@@ -0,0 +1,121 @@
+"""
+Unittests for the adb.fs module
+"""
+import datetime
+import errno
+import os
+import tempfile
+import unittest
+
+from mock import patch
+
+import ffs
+
+class MkdirPTestCase(unittest.TestCase):
+
+ def test_mkdirs(self):
+ "Simple case"
+ with patch.object(ffs.os, 'makedirs') as pmkd:
+ ffs.mkdir_p('/ihd/lost/pairing')
+ pmkd.assert_called_once_with('/ihd/lost/pairing')
+
+ def test_EEXIST(self):
+ "Already exists"
+ def raiser(*args, **kwargs):
+ err = OSError()
+ err.errno = errno.EEXIST
+ raise err
+
+ with patch.object(ffs.os, 'makedirs') as pmkd:
+ pmkd.side_effect = raiser
+ ffs.mkdir_p('/ihd/lost/pairing')
+ pmkd.assert_called_once_with('/ihd/lost/pairing')
+
+ def test_err(self):
+ "Should pass up the err"
+ def raiser(*args, **kwargs):
+ raise ValueError()
+
+ with patch.object(ffs.os, 'makedirs') as pmkd:
+ pmkd.side_effect = raiser
+ with self.assertRaises(ValueError):
+ ffs.mkdir_p('/ihd/lost/pairing')
+ pmkd.assert_called_once_with('/ihd/lost/pairing')
+
+
+class BaseNTestCase(unittest.TestCase):
+
+ def test_basen(self):
+ "Can we split the last n segments of path?"
+ cases = [
+ ('/foo/bar/car/goo.txt', 2, 'car/goo.txt'),
+ ('/foo/bar/car/goo.txt', 1, 'goo.txt'),
+ ('/foo/bar/car/goo.txt', 3, 'bar/car/goo.txt'),
+ ]
+ for path, num, expected in cases:
+ based = ffs.basen(path, num=num)
+ self.assertEqual(expected, based)
+
+class LsmtimeTestCase(unittest.TestCase):
+
+ def test_lessthan(self):
+ "Files modified less than... "
+ mtimes = [456, 789, 123]
+ def mtimer(path):
+ return mtimes.pop()
+
+ def walker(self):
+ yield ['/foo/bar/', [], ['baz.txt', 'caz.txt', 'daz.txt']]
+
+ with patch.object(ffs.os, 'walk') as pwalk:
+ pwalk.side_effect = walker
+
+ with patch.object(ffs.os.path, 'getmtime') as ptime:
+ ptime.side_effect = mtimer
+
+ lessthan = ffs.lsmtime('/foo/bar', datetime.datetime(1970, 1, 1, 0, 3))
+
+ expected = ['/foo/bar/baz.txt']
+
+ self.assertEqual(expected, lessthan)
+
+class RmTestCase(unittest.TestCase):
+ def setUp(self):
+ pass
+
+ def test_(self):
+ """ """
+ pass
+
+ def tearDown(self):
+ pass
+
+class SizeTestCase(unittest.TestCase):
+
+ def test_hsize(self):
+ """ Get the hex size of a file """
+ with tempfile.NamedTemporaryFile(delete=False) as ebl:
+ ebl.write("Hello Beautiful World!\n")
+ ebl.close()
+ self.assertEqual('0x17', ffs.hsize(ebl.name))
+
+ def test_hsize_nofile(self):
+ """ Don't Error if the file doesn't exist """
+ filepath = 'shouldnt_exist.file'
+ self.assertTrue(not os.path.exists(filepath))
+ self.assertEqual(None, ffs.hsize(filepath))
+
+class IsExeTestCase(unittest.TestCase):
+
+ def test_is_exe(self):
+ """ Is a known file executable? """
+ if ffs.OS == "WINDOWS!":
+ path = os.path.abspath('/Windows/system32/notepad.exe')
+ self.assertEqual(True, ffs.is_exe(path))
+ else:
+ self.assertEqual(True, ffs.is_exe('/bin/bash'))
+
+
+
+if __name__ == '__main__':
+ unittest.main()
Please sign in to comment.
Something went wrong with that request. Please try again.