Package couchdbkit :: Module loaders :: Class FileSystemDocsLoader
[hide private]
[frames] | no frames]

Class FileSystemDocsLoader

source code

    object --+    
BaseDocsLoader --+

Load docs from the filesystem. This loader can find docs in folders on the filesystem and is the preferred way to load them.

The loader takes the path for design docs as a string or if multiple locations are wanted a list of them which is then looked up in the given order:

>>> loader = FileSystemDocsLoader('/path/to/templates')
>>> loader = FileSystemDocsLoader(['/path/to/templates', '/other/path'])

You could also do the same to loads docs.

Instance Methods [hide private]
__init__(self, designpath, docpath=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
get_docs(self) source code
sync(self, dbs, atomic=True, **kwargs) source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, designpath, docpath=None)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)


source code 
Overrides: BaseDocsLoader.get_docs

sync(self, dbs, atomic=True, **kwargs)

source code 
Overrides: BaseDocsLoader.sync