File: api.py

package info (click to toggle)
python-pyface 8.0.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 13,944 kB
  • sloc: python: 54,107; makefile: 82
file content (79 lines) | stat: -rw-r--r-- 2,246 bytes parent folder | download
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
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!

"""

API for the ``pyface.timer`` subpackage.

- :func:`~.do_later`
- :func:`~.do_after`
- :class:`~.DoLaterTimer`
- :class:`~.CallbackTimer`
- :class:`~.EventTimer`
- :class:`~.Timer`

Interfaces
----------
- :class:`~.ICallbackTimer`
- :class:`~.IEventTimer`
- :class:`~.ITimer`

"""

from .i_timer import ICallbackTimer, IEventTimer, ITimer


# ----------------------------------------------------------------------------
# Deferred imports
# ----------------------------------------------------------------------------

# These imports have the side-effect of performing toolkit selection

# These are pyface.undo.* imports that have selection as a side-effect
# TODO: refactor to delay imports where possible
_relative_imports = {
    'do_later': 'do_later',
    'do_after': 'do_later',
    'DoLaterTimer': 'do_later',
    'CallbackTimer': 'timer',
    'EventTimer': 'timer',
    'Timer': 'timer',
}


def __getattr__(name):
    """Lazily load attributes with side-effects

    In particular, lazily load toolkit backend names.  For efficiency, lazily
    loaded objects are injected into the module namespace
    """
    # sentinel object for no result
    not_found = object()
    result = not_found

    if name in _relative_imports:
        from importlib import import_module
        source = _relative_imports[name]
        module = import_module(f"pyface.timer.{source}")
        result = getattr(module, name)

    if result is not_found:
        raise AttributeError(f"module {__name__!r} has no attribute {name!r}")

    globals()[name] = result
    return result


# ----------------------------------------------------------------------------
# Introspection support
# ----------------------------------------------------------------------------

def __dir__():
    return sorted(set(globals()) | set(_relative_imports))