docs

Author: willmcgugan

.gitignore

@@ -25,6 +25,7 @@ wheels/
 .installed.cfg
 *.egg
 .DS_Store
+_build/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = S3FS
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,158 @@
+# -*- coding: utf-8 -*-
+#
+# S3FS documentation build configuration file, created by
+# sphinx-quickstart on Sat Aug  5 12:55:45 2017.
+#
+# 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.
+
+# 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.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+import fs_s3fs
+
+# -- 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']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'S3FS'
+copyright = u'2017, Will McGugan'
+author = u'Will McGugan'
+
+# 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 = fs_s3fs.__version__
+# The full version, including alpha/beta/rc tags.
+release = fs_s3fs.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'alabaster'
+
+# 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 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'S3FSdoc'
+
+
+# -- 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': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'S3FS.tex', u'S3FS Documentation',
+     u'Will McGugan', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 's3fs', u'S3FS Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'S3FS', u'S3FS Documentation',
+     author, 'S3FS', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/index.rst

@@ -0,0 +1,108 @@
+.. S3FS documentation master file, created by
+   sphinx-quickstart on Sat Aug  5 12:55:45 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+S3FS
+====
+
+S3FS is a `PyFilesystem interface
+<https://docs.pyfilesystem.org/en/latest/reference/base.html>`_ to
+Amazon S3 cloud storage.
+
+As a PyFilesystem concrete class, S3FS allows you to work with S3 in the
+same as any other supported filesystem.
+
+
+Installing
+==========
+
+S3FS may be installed from pip with the following command::
+
+    pip install fs-s3fs
+
+This will install the most recent stable version.
+
+Alternatively, if you want the cutting edge code, you can check out
+the GitHub repos at https://github.com/pyfilesystem/s3fs
+
+
+Opening an S3 Filesystem
+========================
+
+There are two options for constructing a :ref:`s3fs` instance. The simplest way
+is with an *opener*, which is a simple URL like syntax. Here is an example::
+
+    from fs import open_fs
+    s3fs = S3FS('s3://mybucket/')
+
+For more granular control, you may import the S3FS class and construct
+it explicitly::
+
+    from fs_s3fs import S3FS
+    s3fs = S3FS('mybucket')
+
+
+Authentication
+==============
+
+If you don't supply any credentials, then S3FS will use the access key
+and secret key configured on your system. You may also specify when
+creating the filesystem instance. Here's how you would do that with an
+opener::
+
+    s3fs = open_fs('s3://<access key>:<secret key>/mybucket')
+
+Here's how you specify credentials with the constructor::
+
+    s3fs = S3FS(
+        'mybucket'
+        aws_access_key_id=<access key>,
+        aws_secret_access_key=<secret key>
+    )
+
+.. note::
+
+    Amazon recommends against specifying credentials explicitly like
+    this in production.
+
+
+S3 Info
+=======
+
+You can retrieve S3 info via the ``s3`` namespace. Here's an example:
+
+    >>> info = s.getinfo(u'foo', namespaces=['s3'])
+    >>> info.raw['s3']
+    {u'content_length': 3, u'restore': None, u'sse_customer_key_md5': None, u'content_language': None, u'replication_status': None, u'server_side_encryption': None, u'parts_count': None, u'sse_customer_algorithm': None, u'missing_meta': None, u'delete_marker': None, u'content_encoding': None, u'accept_ranges': 'bytes', u'cache_control': None, u'metadata': {}, u'request_charged': None, u'e_tag': '"37b51d194a7513e45b56f6524f2d51f2"', u'expires': None, u'version_id': None, u'last_modified': 1501935315, u'content_type': 'binary/octet-stream', u'website_redirect_location': None, u'ssekms_key_id': None, u'content_disposition': None, u'storage_class': None, u'expiration': None}
+
+
+URLs
+====
+
+You can use the ``geturl`` method to generate an externally accessible
+URL from an S3 object. Here's an example:
+
+>>> s3fs.geturl('foo')
+'https://fsexample.s3.amazonaws.com//foo?AWSAccessKeyId=AKIAIEZZDQU72WQP3JUA&Expires=1501939084&Signature=4rfDuqVgmvILjtTeYOJvyIXRMvs%3D'
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   s3fs.rst
+
+
+More Information
+================
+
+See the `PyFilesystem Docs <https://docs.pyfilesystem.org>`_ for full
+details.
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/s3fs.rst

@@ -0,0 +1,21 @@
+.. _s3fs:
+
+S3FS
+====
+
+Construct a `PyFilesystem interface <https://docs.pyfilesystem.org/en/latest/reference/base.html>`_ to an Amazon S3 'bucket'.
+
+Here's a silly example::
+
+    from fs_s3fs import S3FS
+    s3fs = S3FS('mybucket')
+    with s3fs.open('foo.txt', 'wt') as fh:
+        fh.write('Writing a file to the cloud!')
+    print(s3fs.listdir(u'/'))
+
+
+S3FS Constructor
+----------------
+
+.. autoclass:: fs_s3fs.S3FS
+    :members:

fs_s3fs/_s3fs.py

@@ -56,9 +56,11 @@ def __repr__(self):
 
 
 class S3File(io.IOBase):
+    """Proxy for a S3 file."""
 
     @classmethod
     def factory(cls, filename, mode, on_close):
+        """Create a S3File backed with a temporary file."""
         _temp_file = tempfile.TemporaryFile()
         proxy = cls(_temp_file, filename, mode, on_close=on_close)
         return proxy
@@ -193,7 +195,7 @@ def s3errors(path):
 @six.python_2_unicode_compatible
 class S3FS(FS):
     """
-    An Amazon S3 filesystem for
+    Construct an Amazon S3 filesystem for
     `PyFilesystem <https://pyfilesystem.org>`_
 
     :param str bucket_name: The S3 bucket name.
@@ -465,6 +467,7 @@ def openbin(self, path, mode="r", buffering=-1, **options):
         _key = self._path_to_key(_path)
 
         if _mode.create:
+
             def on_close(s3file):
                 try:
                     s3file.raw.seek(0)
@@ -589,7 +592,7 @@ def exists(self, path):
             return True
         _key = self._path_to_dir_key(_path)
         try:
-            obj = self._get_object(path, _key)
+            self._get_object(path, _key)
         except errors.ResourceNotFound:
             return False
         else:

fs_s3fs/opener.py

@@ -28,9 +28,4 @@ def open_fs(self, fs_url, parse_result, writeable, create, cwd):
             aws_access_key_id=parse_result.username or None,
             aws_secret_access_key=parse_result.password or None,
         )
-        s3fs = (
-            s3fs.opendir(dir_path, factory=ClosingSubFS)
-            if dir_path else
-            s3fs
-        )
         return s3fs