summaryrefslogtreecommitdiff
path: root/python-objproxies.spec
blob: fea142c8b9b38b60e93998373704035d60fb4779 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
%global _empty_manifest_terminate_build 0
Name:		python-objproxies
Version:	0.9.4
Release:	1
Summary:	General purpose proxy and wrapper types
License:	PSF or ZPL
URL:		http://github.com/soulrebel/objproxies
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/1d/6b/0434d100d411760d4d634e21dc256e259af720887b0c856c5a9b2c97ea30/objproxies-0.9.4.tar.gz
BuildArch:	noarch


%description
The ``objproxies`` module provides some useful base classes for creating
proxies and wrappers for ordinary Python objects. Proxy objects automatically
delegate all attribute access and operations to the proxied object. Wrappers
are similar, but can be subclassed to allow additional attributes and
operations to be added to the wrapped object.
Note that these proxy types are not intended to be tamper-proof; the unproxied
form of an object can be readily accessed using a proxy's ``__subject__``
attribute, and some proxy types even allow this attribute to be set (This can
be handy for algorithms that lazily create circular structures and thus need to
be able to hand out "forward reference" proxies.)
Development status
******************
This is Python 3 port of `ProxyTypes
<http://cheeseshop.python.org/pypi/ProxyTypes>`_ wrote by Phillip J. Eby as
part of `PEAK <http://www.eby-sarna.com/mailman/listinfo/peak>`_ for Python 2.
The namespace was changed from ``peak.util.proxies`` to ``objproxies``. Other
than that it should be a compatible replacement.
So far the following was accomplished:
* Streamlined files and setup
* Ported unittests and doctests
* Cleaned up syntax
v1.0 TODO
+++++++++
* Turn the module in a package, separate functionalities in different modules
* Simplify code wherever possible
* Get positive feedback from a couple of users
Contributions and bug reports are welcome.
Testing
+++++++
When nose is available all tests can be run using:
    nosetests3 --with-doctest  --doctest-extension=rst .
Otherwise standard python will suffice:
    python -m unittest objproxies_tests.py
    python -m doctest README.rst
Proxy Basics
************
Here's a quick demo of the ``ObjectProxy`` type::
    >>> from objproxies import ObjectProxy
    >>> p = ObjectProxy(42)
    >>> p
    42
    >>> isinstance(p, int)
    True
    >>> p.__class__
    <class 'int'>
    >>> p*2
    84
    >>> 'X' * p
    'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
    >>> hex(p)
    '0x2a'
    >>> chr(p)
    '*'
    >>> p ^ 1
    43
    >>> p ** 2
    1764
As you can see, a proxy is virtually indistinguishable from the object it
proxies, except via its ``__subject__`` attribute, and its ``type()``::
    >>> p.__subject__
    42
    >>> type(p)
    <class 'objproxies.ObjectProxy'>
You can change the ``__subject__`` of an ``ObjectProxy``, and it will then
refer to something else::
    >>> p.__subject__ = 99
    >>> p
    99
    >>> p-33
    66
    >>> p.__subject__ = "foo"
    >>> p
    'foo'
All operations are delegated to the subject, including ``setattr`` and
``delattr``::
    >>> class Dummy: pass
    >>> d = Dummy()
    >>> p = ObjectProxy(d)
    >>> p.foo = "bar"
    >>> d.foo
    'bar'
    >>> del p.foo
    >>> hasattr(d,'foo')
    False
Callback Proxies
****************
Sometimes, you may want a proxy's subject to be determined dynamically whenever
the proxy is used.  For this purpose, you can use the ``CallbackProxy`` type,
which accepts a callback function and creates a proxy that will invoke the
callback in order to get the target.  Here's a quick example of a counter that
gets incremented each time it's used, from zero to three::
    >>> from objproxies import CallbackProxy
    >>> callback = iter(range(4)).__next__
    >>> counter = CallbackProxy(callback)
    >>> counter
    0
    >>> counter
    1
    >>> str(counter)
    '2'
    >>> hex(counter)
    '0x3'
    >>> counter
    Traceback (most recent call last):
    StopIteration
As you can see, the callback is automatically invoked on any attempt to use the
proxy.  This is a somewhat silly example; a better one would be something like
a ``thread_id`` proxy that is always equal to the ID # of the thread it's
running in.
A callback proxy's callback can be obtained or changed via the ``get_callback``
and ``set_callback`` functions::
    >>> from objproxies import get_callback, set_callback
    >>> set_callback(counter, lambda: 42)
    >>> counter
    42
    >>> type(get_callback(counter))
    <class 'function'>
Lazy Proxies
************
A ``LazyProxy`` is similar to a ``CallbackProxy``, but its callback is called
at most once, and then cached::
    >>> from objproxies import LazyProxy
    >>> def callback():
    >>> lazy = LazyProxy(callback)
    >>> lazy
    called
    42
    >>> lazy
    42
You can use the ``get_callback`` and ``set_callback`` functions on lazy
proxies, but it has no effect if the callback was already called::
    >>> set_callback(lazy, lambda: 99)
    >>> lazy
    42
But you can use the ``get_cache`` and ``set_cache`` functions to tamper with
the cached value::
    >>> from objproxies import get_cache, set_cache
    >>> get_cache(lazy)
    42
    >>> set_cache(lazy, 99)
    >>> lazy
    99
Wrappers
********
The ``ObjectWrapper``, ``CallbackWrapper`` and ``LazyWrapper`` classes are
similar to their proxy counterparts, except that they are intended to be
subclassed in order to add custom extra attributes or methods.  Any attribute
that exists in a subclass of these classes will be read or written from the
wrapper instance, instead of the wrapped object.  For example::
    >>> from objproxies import ObjectWrapper
    >>> class NameWrapper(ObjectWrapper):
    >>> w = NameWrapper(42, "The Ultimate Answer")
    >>> w
    42
    >>> print(w)
    The Ultimate Answer
    >>> w * 2
    84
    >>> w.name
    'The Ultimate Answer'
Notice that any attributes you add must be defined *in the class*.  You can't
add arbitrary attributes at runtime, because they'll be set on the wrapped
object instead of the wrapper::
    >>> w.foo = 'bar'
    Traceback (most recent call last):
    AttributeError: 'int' object has no attribute 'foo'
Note that this means that all instance attributes must be implemented as either
slots, properties, or have a default value defined in the class body (like the
``name = None`` shown in the example above.
The ``CallbackWrapper`` and ``LazyWrapper`` base classes are basically the same
as ``ObjectWrapper``, except that they use a callback or cached lazy callback
instead of expecting an object as their subject.
``LazyWrapper`` objects are particularly useful when working with expensive
resources, like connections or web browsers, to avoid their creation unless
absolutely needed. 
However resources usually must be released after use by calling a "``close``"
method of some sort. In this case the lazy creation could be triggered just
when the object is not needed anymore, by the call to ``close`` itself. For
this reason when extending ``LazyWrapper`` these methods can be overridden with
a ``@lazymethod`` replacement::
    >>> from objproxies import LazyWrapper, lazymethod
    >>> class LazyCloseable(LazyWrapper):
    >>> import tempfile
    >>> def openf():
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.tell()
    0
    >>> lazyfile.close()
    bye
    >>> bool(lazyfile)
    False
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.write('wake up')
    called
    7
    >>> lazyfile.tell()
    7
    >>> lazyfile.close()  # close for real
    >>> bool(lazyfile)
    True
Advanced: custom subclasses and mixins
**************************************
In addition to all the concrete classes described above, there are also two
abstract base classes: ``AbstractProxy`` and ``AbstractWrapper``.  If you want
to create a mixin type that can be used with any of the concrete types, you
should subclass the abstract version and set ``__slots__`` to an empty list::
    >>> from objproxies import AbstractWrapper
    >>> class NamedMixin(AbstractWrapper):
Then, when you mix it in with the respective base class, you can add back in
any necessary slots, or leave off ``__slots__`` to give the subclass instances
a dictionary of their own::
    >>> from objproxies import CallbackWrapper, LazyWrapper
    >>> class NamedObject(NamedMixin, ObjectWrapper): pass
    >>> class NamedCallback(NamedMixin, CallbackWrapper): pass
    >>> class NamedLazy(NamedMixin, LazyWrapper): pass
    >>> print(NamedObject(42, "The Answer"))
    The Answer
    >>> n = NamedCallback(callback, "Test")
    >>> n
    called
    42
    >>> n
    called
    42
    >>> n = NamedLazy(callback, "Once")
    >>> n
    called
    42
    >>> n
    42
Both the ``AbstractProxy`` and ``AbstractWrapper`` base classes work by
assuming that ``self.__subject__`` will be the wrapped or proxed object.  If
you don't want to use any of the standard three ways of defining
``__subject__`` (i.e., as an object, callback, or lazy callback), you will need
to subclass ``AbstractProxy`` or ``AbstractWrapper`` and provide your own way
of defining ``__subject__``.

%package -n python3-objproxies
Summary:	General purpose proxy and wrapper types
Provides:	python-objproxies
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-objproxies
The ``objproxies`` module provides some useful base classes for creating
proxies and wrappers for ordinary Python objects. Proxy objects automatically
delegate all attribute access and operations to the proxied object. Wrappers
are similar, but can be subclassed to allow additional attributes and
operations to be added to the wrapped object.
Note that these proxy types are not intended to be tamper-proof; the unproxied
form of an object can be readily accessed using a proxy's ``__subject__``
attribute, and some proxy types even allow this attribute to be set (This can
be handy for algorithms that lazily create circular structures and thus need to
be able to hand out "forward reference" proxies.)
Development status
******************
This is Python 3 port of `ProxyTypes
<http://cheeseshop.python.org/pypi/ProxyTypes>`_ wrote by Phillip J. Eby as
part of `PEAK <http://www.eby-sarna.com/mailman/listinfo/peak>`_ for Python 2.
The namespace was changed from ``peak.util.proxies`` to ``objproxies``. Other
than that it should be a compatible replacement.
So far the following was accomplished:
* Streamlined files and setup
* Ported unittests and doctests
* Cleaned up syntax
v1.0 TODO
+++++++++
* Turn the module in a package, separate functionalities in different modules
* Simplify code wherever possible
* Get positive feedback from a couple of users
Contributions and bug reports are welcome.
Testing
+++++++
When nose is available all tests can be run using:
    nosetests3 --with-doctest  --doctest-extension=rst .
Otherwise standard python will suffice:
    python -m unittest objproxies_tests.py
    python -m doctest README.rst
Proxy Basics
************
Here's a quick demo of the ``ObjectProxy`` type::
    >>> from objproxies import ObjectProxy
    >>> p = ObjectProxy(42)
    >>> p
    42
    >>> isinstance(p, int)
    True
    >>> p.__class__
    <class 'int'>
    >>> p*2
    84
    >>> 'X' * p
    'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
    >>> hex(p)
    '0x2a'
    >>> chr(p)
    '*'
    >>> p ^ 1
    43
    >>> p ** 2
    1764
As you can see, a proxy is virtually indistinguishable from the object it
proxies, except via its ``__subject__`` attribute, and its ``type()``::
    >>> p.__subject__
    42
    >>> type(p)
    <class 'objproxies.ObjectProxy'>
You can change the ``__subject__`` of an ``ObjectProxy``, and it will then
refer to something else::
    >>> p.__subject__ = 99
    >>> p
    99
    >>> p-33
    66
    >>> p.__subject__ = "foo"
    >>> p
    'foo'
All operations are delegated to the subject, including ``setattr`` and
``delattr``::
    >>> class Dummy: pass
    >>> d = Dummy()
    >>> p = ObjectProxy(d)
    >>> p.foo = "bar"
    >>> d.foo
    'bar'
    >>> del p.foo
    >>> hasattr(d,'foo')
    False
Callback Proxies
****************
Sometimes, you may want a proxy's subject to be determined dynamically whenever
the proxy is used.  For this purpose, you can use the ``CallbackProxy`` type,
which accepts a callback function and creates a proxy that will invoke the
callback in order to get the target.  Here's a quick example of a counter that
gets incremented each time it's used, from zero to three::
    >>> from objproxies import CallbackProxy
    >>> callback = iter(range(4)).__next__
    >>> counter = CallbackProxy(callback)
    >>> counter
    0
    >>> counter
    1
    >>> str(counter)
    '2'
    >>> hex(counter)
    '0x3'
    >>> counter
    Traceback (most recent call last):
    StopIteration
As you can see, the callback is automatically invoked on any attempt to use the
proxy.  This is a somewhat silly example; a better one would be something like
a ``thread_id`` proxy that is always equal to the ID # of the thread it's
running in.
A callback proxy's callback can be obtained or changed via the ``get_callback``
and ``set_callback`` functions::
    >>> from objproxies import get_callback, set_callback
    >>> set_callback(counter, lambda: 42)
    >>> counter
    42
    >>> type(get_callback(counter))
    <class 'function'>
Lazy Proxies
************
A ``LazyProxy`` is similar to a ``CallbackProxy``, but its callback is called
at most once, and then cached::
    >>> from objproxies import LazyProxy
    >>> def callback():
    >>> lazy = LazyProxy(callback)
    >>> lazy
    called
    42
    >>> lazy
    42
You can use the ``get_callback`` and ``set_callback`` functions on lazy
proxies, but it has no effect if the callback was already called::
    >>> set_callback(lazy, lambda: 99)
    >>> lazy
    42
But you can use the ``get_cache`` and ``set_cache`` functions to tamper with
the cached value::
    >>> from objproxies import get_cache, set_cache
    >>> get_cache(lazy)
    42
    >>> set_cache(lazy, 99)
    >>> lazy
    99
Wrappers
********
The ``ObjectWrapper``, ``CallbackWrapper`` and ``LazyWrapper`` classes are
similar to their proxy counterparts, except that they are intended to be
subclassed in order to add custom extra attributes or methods.  Any attribute
that exists in a subclass of these classes will be read or written from the
wrapper instance, instead of the wrapped object.  For example::
    >>> from objproxies import ObjectWrapper
    >>> class NameWrapper(ObjectWrapper):
    >>> w = NameWrapper(42, "The Ultimate Answer")
    >>> w
    42
    >>> print(w)
    The Ultimate Answer
    >>> w * 2
    84
    >>> w.name
    'The Ultimate Answer'
Notice that any attributes you add must be defined *in the class*.  You can't
add arbitrary attributes at runtime, because they'll be set on the wrapped
object instead of the wrapper::
    >>> w.foo = 'bar'
    Traceback (most recent call last):
    AttributeError: 'int' object has no attribute 'foo'
Note that this means that all instance attributes must be implemented as either
slots, properties, or have a default value defined in the class body (like the
``name = None`` shown in the example above.
The ``CallbackWrapper`` and ``LazyWrapper`` base classes are basically the same
as ``ObjectWrapper``, except that they use a callback or cached lazy callback
instead of expecting an object as their subject.
``LazyWrapper`` objects are particularly useful when working with expensive
resources, like connections or web browsers, to avoid their creation unless
absolutely needed. 
However resources usually must be released after use by calling a "``close``"
method of some sort. In this case the lazy creation could be triggered just
when the object is not needed anymore, by the call to ``close`` itself. For
this reason when extending ``LazyWrapper`` these methods can be overridden with
a ``@lazymethod`` replacement::
    >>> from objproxies import LazyWrapper, lazymethod
    >>> class LazyCloseable(LazyWrapper):
    >>> import tempfile
    >>> def openf():
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.tell()
    0
    >>> lazyfile.close()
    bye
    >>> bool(lazyfile)
    False
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.write('wake up')
    called
    7
    >>> lazyfile.tell()
    7
    >>> lazyfile.close()  # close for real
    >>> bool(lazyfile)
    True
Advanced: custom subclasses and mixins
**************************************
In addition to all the concrete classes described above, there are also two
abstract base classes: ``AbstractProxy`` and ``AbstractWrapper``.  If you want
to create a mixin type that can be used with any of the concrete types, you
should subclass the abstract version and set ``__slots__`` to an empty list::
    >>> from objproxies import AbstractWrapper
    >>> class NamedMixin(AbstractWrapper):
Then, when you mix it in with the respective base class, you can add back in
any necessary slots, or leave off ``__slots__`` to give the subclass instances
a dictionary of their own::
    >>> from objproxies import CallbackWrapper, LazyWrapper
    >>> class NamedObject(NamedMixin, ObjectWrapper): pass
    >>> class NamedCallback(NamedMixin, CallbackWrapper): pass
    >>> class NamedLazy(NamedMixin, LazyWrapper): pass
    >>> print(NamedObject(42, "The Answer"))
    The Answer
    >>> n = NamedCallback(callback, "Test")
    >>> n
    called
    42
    >>> n
    called
    42
    >>> n = NamedLazy(callback, "Once")
    >>> n
    called
    42
    >>> n
    42
Both the ``AbstractProxy`` and ``AbstractWrapper`` base classes work by
assuming that ``self.__subject__`` will be the wrapped or proxed object.  If
you don't want to use any of the standard three ways of defining
``__subject__`` (i.e., as an object, callback, or lazy callback), you will need
to subclass ``AbstractProxy`` or ``AbstractWrapper`` and provide your own way
of defining ``__subject__``.

%package help
Summary:	Development documents and examples for objproxies
Provides:	python3-objproxies-doc
%description help
The ``objproxies`` module provides some useful base classes for creating
proxies and wrappers for ordinary Python objects. Proxy objects automatically
delegate all attribute access and operations to the proxied object. Wrappers
are similar, but can be subclassed to allow additional attributes and
operations to be added to the wrapped object.
Note that these proxy types are not intended to be tamper-proof; the unproxied
form of an object can be readily accessed using a proxy's ``__subject__``
attribute, and some proxy types even allow this attribute to be set (This can
be handy for algorithms that lazily create circular structures and thus need to
be able to hand out "forward reference" proxies.)
Development status
******************
This is Python 3 port of `ProxyTypes
<http://cheeseshop.python.org/pypi/ProxyTypes>`_ wrote by Phillip J. Eby as
part of `PEAK <http://www.eby-sarna.com/mailman/listinfo/peak>`_ for Python 2.
The namespace was changed from ``peak.util.proxies`` to ``objproxies``. Other
than that it should be a compatible replacement.
So far the following was accomplished:
* Streamlined files and setup
* Ported unittests and doctests
* Cleaned up syntax
v1.0 TODO
+++++++++
* Turn the module in a package, separate functionalities in different modules
* Simplify code wherever possible
* Get positive feedback from a couple of users
Contributions and bug reports are welcome.
Testing
+++++++
When nose is available all tests can be run using:
    nosetests3 --with-doctest  --doctest-extension=rst .
Otherwise standard python will suffice:
    python -m unittest objproxies_tests.py
    python -m doctest README.rst
Proxy Basics
************
Here's a quick demo of the ``ObjectProxy`` type::
    >>> from objproxies import ObjectProxy
    >>> p = ObjectProxy(42)
    >>> p
    42
    >>> isinstance(p, int)
    True
    >>> p.__class__
    <class 'int'>
    >>> p*2
    84
    >>> 'X' * p
    'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
    >>> hex(p)
    '0x2a'
    >>> chr(p)
    '*'
    >>> p ^ 1
    43
    >>> p ** 2
    1764
As you can see, a proxy is virtually indistinguishable from the object it
proxies, except via its ``__subject__`` attribute, and its ``type()``::
    >>> p.__subject__
    42
    >>> type(p)
    <class 'objproxies.ObjectProxy'>
You can change the ``__subject__`` of an ``ObjectProxy``, and it will then
refer to something else::
    >>> p.__subject__ = 99
    >>> p
    99
    >>> p-33
    66
    >>> p.__subject__ = "foo"
    >>> p
    'foo'
All operations are delegated to the subject, including ``setattr`` and
``delattr``::
    >>> class Dummy: pass
    >>> d = Dummy()
    >>> p = ObjectProxy(d)
    >>> p.foo = "bar"
    >>> d.foo
    'bar'
    >>> del p.foo
    >>> hasattr(d,'foo')
    False
Callback Proxies
****************
Sometimes, you may want a proxy's subject to be determined dynamically whenever
the proxy is used.  For this purpose, you can use the ``CallbackProxy`` type,
which accepts a callback function and creates a proxy that will invoke the
callback in order to get the target.  Here's a quick example of a counter that
gets incremented each time it's used, from zero to three::
    >>> from objproxies import CallbackProxy
    >>> callback = iter(range(4)).__next__
    >>> counter = CallbackProxy(callback)
    >>> counter
    0
    >>> counter
    1
    >>> str(counter)
    '2'
    >>> hex(counter)
    '0x3'
    >>> counter
    Traceback (most recent call last):
    StopIteration
As you can see, the callback is automatically invoked on any attempt to use the
proxy.  This is a somewhat silly example; a better one would be something like
a ``thread_id`` proxy that is always equal to the ID # of the thread it's
running in.
A callback proxy's callback can be obtained or changed via the ``get_callback``
and ``set_callback`` functions::
    >>> from objproxies import get_callback, set_callback
    >>> set_callback(counter, lambda: 42)
    >>> counter
    42
    >>> type(get_callback(counter))
    <class 'function'>
Lazy Proxies
************
A ``LazyProxy`` is similar to a ``CallbackProxy``, but its callback is called
at most once, and then cached::
    >>> from objproxies import LazyProxy
    >>> def callback():
    >>> lazy = LazyProxy(callback)
    >>> lazy
    called
    42
    >>> lazy
    42
You can use the ``get_callback`` and ``set_callback`` functions on lazy
proxies, but it has no effect if the callback was already called::
    >>> set_callback(lazy, lambda: 99)
    >>> lazy
    42
But you can use the ``get_cache`` and ``set_cache`` functions to tamper with
the cached value::
    >>> from objproxies import get_cache, set_cache
    >>> get_cache(lazy)
    42
    >>> set_cache(lazy, 99)
    >>> lazy
    99
Wrappers
********
The ``ObjectWrapper``, ``CallbackWrapper`` and ``LazyWrapper`` classes are
similar to their proxy counterparts, except that they are intended to be
subclassed in order to add custom extra attributes or methods.  Any attribute
that exists in a subclass of these classes will be read or written from the
wrapper instance, instead of the wrapped object.  For example::
    >>> from objproxies import ObjectWrapper
    >>> class NameWrapper(ObjectWrapper):
    >>> w = NameWrapper(42, "The Ultimate Answer")
    >>> w
    42
    >>> print(w)
    The Ultimate Answer
    >>> w * 2
    84
    >>> w.name
    'The Ultimate Answer'
Notice that any attributes you add must be defined *in the class*.  You can't
add arbitrary attributes at runtime, because they'll be set on the wrapped
object instead of the wrapper::
    >>> w.foo = 'bar'
    Traceback (most recent call last):
    AttributeError: 'int' object has no attribute 'foo'
Note that this means that all instance attributes must be implemented as either
slots, properties, or have a default value defined in the class body (like the
``name = None`` shown in the example above.
The ``CallbackWrapper`` and ``LazyWrapper`` base classes are basically the same
as ``ObjectWrapper``, except that they use a callback or cached lazy callback
instead of expecting an object as their subject.
``LazyWrapper`` objects are particularly useful when working with expensive
resources, like connections or web browsers, to avoid their creation unless
absolutely needed. 
However resources usually must be released after use by calling a "``close``"
method of some sort. In this case the lazy creation could be triggered just
when the object is not needed anymore, by the call to ``close`` itself. For
this reason when extending ``LazyWrapper`` these methods can be overridden with
a ``@lazymethod`` replacement::
    >>> from objproxies import LazyWrapper, lazymethod
    >>> class LazyCloseable(LazyWrapper):
    >>> import tempfile
    >>> def openf():
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.tell()
    0
    >>> lazyfile.close()
    bye
    >>> bool(lazyfile)
    False
    >>> lazyfile = LazyCloseable(openf)
    >>> lazyfile.write('wake up')
    called
    7
    >>> lazyfile.tell()
    7
    >>> lazyfile.close()  # close for real
    >>> bool(lazyfile)
    True
Advanced: custom subclasses and mixins
**************************************
In addition to all the concrete classes described above, there are also two
abstract base classes: ``AbstractProxy`` and ``AbstractWrapper``.  If you want
to create a mixin type that can be used with any of the concrete types, you
should subclass the abstract version and set ``__slots__`` to an empty list::
    >>> from objproxies import AbstractWrapper
    >>> class NamedMixin(AbstractWrapper):
Then, when you mix it in with the respective base class, you can add back in
any necessary slots, or leave off ``__slots__`` to give the subclass instances
a dictionary of their own::
    >>> from objproxies import CallbackWrapper, LazyWrapper
    >>> class NamedObject(NamedMixin, ObjectWrapper): pass
    >>> class NamedCallback(NamedMixin, CallbackWrapper): pass
    >>> class NamedLazy(NamedMixin, LazyWrapper): pass
    >>> print(NamedObject(42, "The Answer"))
    The Answer
    >>> n = NamedCallback(callback, "Test")
    >>> n
    called
    42
    >>> n
    called
    42
    >>> n = NamedLazy(callback, "Once")
    >>> n
    called
    42
    >>> n
    42
Both the ``AbstractProxy`` and ``AbstractWrapper`` base classes work by
assuming that ``self.__subject__`` will be the wrapped or proxed object.  If
you don't want to use any of the standard three ways of defining
``__subject__`` (i.e., as an object, callback, or lazy callback), you will need
to subclass ``AbstractProxy`` or ``AbstractWrapper`` and provide your own way
of defining ``__subject__``.

%prep
%autosetup -n objproxies-0.9.4

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-objproxies -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.9.4-1
- Package Spec generated