Commit 189ca951 authored by Maciej Wiatrzyk's avatar Maciej Wiatrzyk
Browse files

rename: pydio.variant -> pydio.keys

+ some fixes in docs
parent c4e339f2
......@@ -20,5 +20,5 @@ API Reference
api/base
api/exc
api/injector
api/keys
api/provider
api/variant
......@@ -10,8 +10,8 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.api** - A handy shortcut to most commonly used classes
==============================================================
**pydio.api** - All core classes in one place
=============================================
.. automodule:: pydio.api
:members:
......@@ -10,7 +10,7 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.base** - Abstract base classes
**pydio.base** - Interface definitions
======================================
.. automodule:: pydio.base
......
......@@ -10,8 +10,8 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.exc** - Common library exceptions
=========================================
**pydio.exc** - Base exceptions
===============================
.. automodule:: pydio.exc
:members:
......
......@@ -10,8 +10,8 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.injector** - Dependency injector implementation
=======================================================
**pydio.injector** - Dependency injector
========================================
.. automodule:: pydio.injector
:members:
......
......@@ -10,9 +10,9 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.variant** - Parametrized key proxy
==========================================
**pydio.keys** - Key wrappers for special purposes
==================================================
.. automodule:: pydio.variant
.. automodule:: pydio.keys
:members:
:show-inheritance:
......@@ -10,8 +10,8 @@
.. See LICENSE.txt for details.
.. ----------------------------------------------------------------------------
**pydio.provider** - Object factory provider implementation
===========================================================
**pydio.provider** - Object factory provider
============================================
.. automodule:: pydio.provider
:members:
......
......@@ -8,28 +8,20 @@
#
# See LICENSE.txt for details.
# ---------------------------------------------------------------------------
"""A module providing aliases to most common used classes.
"""An all-in-one module for making imports easier.
You can use this in your code to create one-line imports. For example,
instead of doing this:
.. testcode::
from pydio.injector import Injector
from pydio.provider import Provider
You can do this:
instead of adding multiple PyDio imports to your application, you can do
this instead:
.. testcode::
from pydio.api import Injector, Provider
This is a replacement for commonly used ``from toolkit import Foo, Bar``
idiom, which is discouraged due to performance reasons.
"""
from .injector import Injector
from .provider import Provider
from .variant import Variant
from .keys import Variant
__all__ = [
'Injector',
......
......@@ -8,7 +8,7 @@
#
# See LICENSE.txt for details.
# ---------------------------------------------------------------------------
from pydio.variant import Variant
from pydio.keys import Variant
class TestVariant:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment