FM / _sources

/usr/share/doc/python3-zope-component/html/_sources/

/usr/share/doc/python3-zope-component/html/_sources

Name	Size	Mode	Actions
api/	-	0755	rm
api.rst.txt	237	0644	edit dl rm
configure.rst.txt	1052	0644	edit dl rm
event.rst.txt	3663	0644	edit dl rm
factory.rst.txt	3104	0644	edit dl rm
hacking.rst.txt	10562	0644	edit dl rm
hooks.rst.txt	2791	0644	edit dl rm
index.rst.txt	306	0644	edit dl rm
narr.rst.txt	12647	0644	edit dl rm
persistentregistry.rst.txt	207	0644	edit dl rm
socketexample.rst.txt	21767	0644	edit dl rm
testlayer.rst.txt	3445	0644	edit dl rm
zcml.rst.txt	33599	0644	edit dl rm

Edit: /usr/share/doc/python3-zope-component/html/_sources/factory.rst.txt (3104B)

Factories
=========

The Factory Class
-----------------

.. doctest::

>>> from zope.interface import Interface
   >>> class IFunction(Interface):
   ...     pass

>>> class IKlass(Interface):
   ...     pass

>>> from zope.interface import implements
   >>> class Klass(object):
   ...     implements(IKlass)
   ... 
   ...     def __init__(self, *args, **kw): #*
   ...         self.args = args
   ...         self.kw = kw

>>> from zope.component.factory import Factory
   >>> factory = Factory(Klass, 'Klass', 'Klassier')
   >>> factory2 = Factory(lambda x: x, 'Func', 'Function')
   >>> factory3 = Factory(lambda x: x, 'Func', 'Function', (IFunction,))

Calling a Factory
~~~~~~~~~~~~~~~~~

Here we test whether the factory correctly creates the objects and
including the correct handling of constructor elements.

First we create a factory that creates instanace of the `Klass` class:

.. doctest::

>>> factory = Factory(Klass, 'Klass', 'Klassier')

Now we use the factory to create the instance

.. doctest::

>>> kl = factory(1, 2, foo=3)

and make sure that the correct class was used to create the object:

.. doctest::

>>> kl.__class__
   <class 'Klass'>

Since we passed in a couple positional and a keyword argument
  
.. doctest::

>>> kl.args
   (1, 2)
   >>> kl.kw
   {'foo': 3}
   
   >>> factory2(3)
   3
   >>> factory3(3)
   3

Title and Description
~~~~~~~~~~~~~~~~~~~~~

.. doctest::

>>> factory.title
   'Klass'
   >>> factory.description
   'Klassier'
   >>> factory2.title
   'Func'
   >>> factory2.description
   'Function'
   >>> factory3.title
   'Func'
   >>> factory3.description
   'Function'

Provided Interfaces
~~~~~~~~~~~~~~~~~~~

.. doctest::

>>> implemented = factory.getInterfaces()
   >>> implemented.isOrExtends(IKlass)
   True
   >>> list(implemented)
   [<InterfaceClass __builtin__.IKlass>]
   
   >>> implemented2 = factory2.getInterfaces()
   >>> list(implemented2)
   []
   
   >>> implemented3 = factory3.getInterfaces()
   >>> list(implemented3)
   [<InterfaceClass __builtin__.IFunction>]

The Component Architecture Factory API
--------------------------------------

.. doctest::

>>> import zope.component
   >>> factory = Factory(Klass, 'Klass', 'Klassier')
   >>> gsm = zope.component.getGlobalSiteManager()

>>> from zope.component.interfaces import IFactory
   >>> gsm.registerUtility(factory, IFactory, 'klass')

Creating an Object
~~~~~~~~~~~~~~~~~~

.. doctest::

>>> kl = zope.component.createObject('klass', 1, 2, foo=3)
   >>> isinstance(kl, Klass)
   True
   >>> kl.args
   (1, 2)
   >>> kl.kw
   {'foo': 3}

Accessing Provided Interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. doctest::

>>> implemented = zope.component.getFactoryInterfaces('klass')
   >>> implemented.isOrExtends(IKlass)
   True
   >>> [iface for iface in implemented]
   [<InterfaceClass __builtin__.IKlass>]

List of All Factories
~~~~~~~~~~~~~~~~~~~~~

.. doctest::

>>> [(name, fac.__class__) for name, fac in
   ...  zope.component.getFactoriesFor(IKlass)]
   [(u'klass', <class 'zope.component.factory.Factory'>)]

Factories ========= The Factory Class ----------------- .. doctest:: >>> from zope.interface import Interface >>> class IFunction(Interface): ... pass >>> class IKlass(Interface): ... pass >>> from zope.interface import implements >>> class Klass(object): ... implements(IKlass) ... ... def __init__(self, *args, **kw): #* ... self.args = args ... self.kw = kw >>> from zope.component.factory import Factory >>> factory = Factory(Klass, 'Klass', 'Klassier') >>> factory2 = Factory(lambda x: x, 'Func', 'Function') >>> factory3 = Factory(lambda x: x, 'Func', 'Function', (IFunction,)) Calling a Factory ~~~~~~~~~~~~~~~~~ Here we test whether the factory correctly creates the objects and including the correct handling of constructor elements. First we create a factory that creates instanace of the `Klass` class: .. doctest:: >>> factory = Factory(Klass, 'Klass', 'Klassier') Now we use the factory to create the instance .. doctest:: >>> kl = factory(1, 2, foo=3) and make sure that the correct class was used to create the object: .. doctest:: >>> kl.__class__ Since we passed in a couple positional and a keyword argument .. doctest:: >>> kl.args (1, 2) >>> kl.kw {'foo': 3} >>> factory2(3) 3 >>> factory3(3) 3 Title and Description ~~~~~~~~~~~~~~~~~~~~~ .. doctest:: >>> factory.title 'Klass' >>> factory.description 'Klassier' >>> factory2.title 'Func' >>> factory2.description 'Function' >>> factory3.title 'Func' >>> factory3.description 'Function' Provided Interfaces ~~~~~~~~~~~~~~~~~~~ .. doctest:: >>> implemented = factory.getInterfaces() >>> implemented.isOrExtends(IKlass) True >>> list(implemented) [] >>> implemented2 = factory2.getInterfaces() >>> list(implemented2) [] >>> implemented3 = factory3.getInterfaces() >>> list(implemented3) [] The Component Architecture Factory API -------------------------------------- .. doctest:: >>> import zope.component >>> factory = Factory(Klass, 'Klass', 'Klassier') >>> gsm = zope.component.getGlobalSiteManager() >>> from zope.component.interfaces import IFactory >>> gsm.registerUtility(factory, IFactory, 'klass') Creating an Object ~~~~~~~~~~~~~~~~~~ .. doctest:: >>> kl = zope.component.createObject('klass', 1, 2, foo=3) >>> isinstance(kl, Klass) True >>> kl.args (1, 2) >>> kl.kw {'foo': 3} Accessing Provided Interfaces ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. doctest:: >>> implemented = zope.component.getFactoryInterfaces('klass') >>> implemented.isOrExtends(IKlass) True >>> [iface for iface in implemented] [] List of All Factories ~~~~~~~~~~~~~~~~~~~~~ .. doctest:: >>> [(name, fac.__class__) for name, fac in ... zope.component.getFactoriesFor(IKlass)] [(u'klass', )]